{ "openapi": "3.1.0", "info": { "title": "Aurax BFF Service", "version": "1d7399bd61b1", "summary": "DgCore platform API surface for the Aurax BFF Service domain.", "description": "The Aurax BFF Service domain: 1110 operations across 298 resource groups.\n\nThis is the published contract, not a description of a running deployment: the environment\nyou were granted may carry operations this document does not, and may not carry every\noperation listed here." }, "servers": [ { "url": "https://{gateway}/aurax-bff-service", "description": "The full route is `https:///aurax-bff-service/`. The service segment is fixed; the gateway host is the one you were granted. Substitute it below.", "variables": { "gateway": { "default": "gateway.example" } } } ], "tags": [ { "name": "account-cash-transactions", "description": "Operations addressed under `/account-cash-transactions` — 3 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "account-cash-transactions-old", "description": "Operations addressed under `/account-cash-transactions-old` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "account-product-rules", "description": "Operations addressed under `/account-product-rules` — 7 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "account-products", "description": "Operations addressed under `/account-products` — 10 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "account-transactions", "description": "Operations addressed under `/account-transactions` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "accounting-entries", "description": "Operations addressed under `/accounting-entries` — 4 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "accounting-entry-data-list", "description": "Operations addressed under `/accounting-entry-data-list` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "accounting-entry-definitions", "description": "Operations addressed under `/accounting-entry-definitions` — 6 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "accounting-transactions", "description": "Operations addressed under `/accounting-transactions` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "accounts", "description": "Operations addressed under `/accounts` — 8 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "accrual-calculation", "description": "Operations addressed under `/accrual-calculation` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "accrual-products", "description": "Operations addressed under `/accrual-products` — 4 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "accrual-transactions", "description": "Operations addressed under `/accrual-transactions` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "action-groups", "description": "Operations addressed under `/action-groups` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "actions", "description": "Operations addressed under `/actions` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "address", "description": "Operations addressed under `/address` — 6 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "address-types", "description": "Operations addressed under `/address-types` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "admin", "description": "Operations addressed under `/admin` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "allotment-assignments", "description": "Operations addressed under `/allotment-assignments` — 3 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "allotment-products", "description": "Operations addressed under `/allotment-products` — 6 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "allotment-queries", "description": "Operations addressed under `/allotment-queries` — 2 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "aml-item-configs", "description": "Operations addressed under `/aml-item-configs` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "approve-corporate-assignment-request-bpmn", "description": "Operations addressed under `/portalrove-corporate-assignment-request-bpmn` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "approved-contacts", "description": "Operations addressed under `/portalroved-contacts` — 6 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "assignments", "description": "Operations addressed under `/assignments` — 3 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "authorized-users", "description": "Operations addressed under `/authorized-users` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "balances", "description": "Operations addressed under `/balances` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "base-prices", "description": "Operations addressed under `/base-prices` — 6 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "batch-accounting-entries", "description": "Operations addressed under `/batch-accounting-entries` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "batch-accounting-entry-files", "description": "Operations addressed under `/batch-accounting-entry-files` — 3 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "batch-catalog", "description": "Operations addressed under `/batch-catalog` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "blacklists", "description": "Operations addressed under `/blacklists` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "blocked-items", "description": "Operations addressed under `/blocked-items` — 4 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "business-core", "description": "Operations addressed under `/business-core` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "business-field-definitions", "description": "Operations addressed under `/business-field-definitions` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "caches", "description": "Operations addressed under `/caches` — 2 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "calculate-customer-current-total-loan-debt-restructure-bpmn", "description": "Operations addressed under `/calculate-customer-current-total-loan-debt-restructure-bpmn` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "calculate-variable-intereset-recalculate-payback-plan-bpmn", "description": "Operations addressed under `/calculate-variable-intereset-recalculate-payback-plan-bpmn` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "calendar-dimensions", "description": "Operations addressed under `/calendar-dimensions` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "calendars", "description": "Operations addressed under `/calendars` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "cash-box-reconcilation-ui", "description": "Operations addressed under `/cash-box-reconcilation-ui` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "cash-flow-validation", "description": "Operations addressed under `/cash-flow-validation` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "cashbalance-transactions", "description": "Operations addressed under `/cashbalance-transactions` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "cashbox-reconcilation", "description": "Operations addressed under `/cashbox-reconcilation` — 2 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "cashbox-transfer", "description": "Operations addressed under `/cashbox-transfer` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "cashs", "description": "Operations addressed under `/cashs` — 7 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "central-bank-transaction-limits", "description": "Operations addressed under `/central-bank-transaction-limits` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "channels", "description": "Operations addressed under `/channels` — 6 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "check-virtual-iban-bpm", "description": "Operations addressed under `/check-virtual-iban-bpm` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "client-logs", "description": "Operations addressed under `/client-logs` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "clients", "description": "Operations addressed under `/clients` — 32 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "collateral-types", "description": "Operations addressed under `/collateral-types` — 4 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "collaterals", "description": "Operations addressed under `/collaterals` — 13 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "committees", "description": "Operations addressed under `/committees` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "compensating-transactions", "description": "Operations addressed under `/compensating-transactions` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "complete-fasts", "description": "Operations addressed under `/complete-fasts` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "configs", "description": "Operations addressed under `/configs` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "consent-items", "description": "Operations addressed under `/consent-items` — 2 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "consents", "description": "Operations addressed under `/consents` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "control-item-groups", "description": "Operations addressed under `/control-item-groups` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "control-items", "description": "Operations addressed under `/control-items` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "control-views", "description": "Operations addressed under `/control-views` — 6 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "copy-authorization-permission", "description": "Operations addressed under `/copy-authorization-permission` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "corporate-assignment-requests", "description": "Operations addressed under `/corporate-assignment-requests` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "corporate-assignments", "description": "Operations addressed under `/corporate-assignments` — 6 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "corporate-customers", "description": "Operations addressed under `/corporate-customers` — 3 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "corporate-scores", "description": "Operations addressed under `/corporate-scores` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "countries", "description": "Operations addressed under `/countries` — 13 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "create-accounting-entry-bpmn", "description": "Operations addressed under `/create-accounting-entry-bpmn` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "create-address-email-emlak", "description": "Operations addressed under `/create-address-email-emlak` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "create-allotment-assignment-request-bpmn", "description": "Operations addressed under `/create-allotment-assignment-request-bpmn` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "create-bullet-payment", "description": "Operations addressed under `/create-bullet-payment` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "create-customer-administrative-follow-bpmn", "description": "Operations addressed under `/create-customer-administrative-follow-bpmn` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "create-customer-audit", "description": "Operations addressed under `/create-customer-audit` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "create-customer-emlak", "description": "Operations addressed under `/create-customer-emlak` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "create-customer-follow-for-follow-loan-bpmn", "description": "Operations addressed under `/create-customer-follow-for-follow-loan-bpmn` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "create-customer-legal-follow-five-scheduler-bpmn", "description": "Operations addressed under `/create-customer-legal-follow-five-scheduler-bpmn` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "create-customer-legal-follow-one-bpmn", "description": "Operations addressed under `/create-customer-legal-follow-one-bpmn` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "create-customer-legal-follow-six-scheduler-bpmn", "description": "Operations addressed under `/create-customer-legal-follow-six-scheduler-bpmn` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "create-customer-loan-collateral-pledge-ui-bpmn", "description": "Operations addressed under `/create-customer-loan-collateral-pledge-ui-bpmn` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "create-denomination-bpmn", "description": "Operations addressed under `/create-denomination-bpmn` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "create-easy-address", "description": "Operations addressed under `/create-easy-address` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "create-eledger-request-bpmn", "description": "Operations addressed under `/create-eledger-request-bpmn` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "create-general-provision-for-loan-scheduler-bpmn", "description": "Operations addressed under `/create-general-provision-for-loan-scheduler-bpmn` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "create-loan-for-corporate-foreign-trade-channel-ui-bpmn", "description": "Operations addressed under `/create-loan-for-corporate-foreign-trade-channel-ui-bpmn` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "create-loan-invoice-ui-bpmn", "description": "Operations addressed under `/create-loan-invoice-ui-bpmn` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "create-potential-corporate-customer-ui-bpm", "description": "Operations addressed under `/create-potential-corporate-customer-ui-bpm` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "create-restructure-ui-bpmn", "description": "Operations addressed under `/create-restructure-ui-bpmn` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "create-special-provision-for-loan-scheduler-bpmn", "description": "Operations addressed under `/create-special-provision-for-loan-scheduler-bpmn` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "create-vendor-disbursement-without-confirmation-ui-bpmn", "description": "Operations addressed under `/create-vendor-disbursement-without-confirmation-ui-bpmn` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "create-verified-customer", "description": "Operations addressed under `/create-verified-customer` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "create-verified-customer-enqura", "description": "Operations addressed under `/create-verified-customer-enqura` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "create-verify-enqura-emlak", "description": "Operations addressed under `/create-verify-enqura-emlak` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "create-virtual-iban-bpm", "description": "Operations addressed under `/create-virtual-iban-bpm` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "credit-bureau-infos", "description": "Operations addressed under `/credit-bureau-infos` — 3 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "currencies", "description": "Operations addressed under `/currencies` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "customer-application", "description": "Operations addressed under `/customer-application` — 3 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "customer-application-evaluate", "description": "Operations addressed under `/customer-application-evaluate` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "customer-application-limit-assign", "description": "Operations addressed under `/customer-application-limit-assign` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "customer-application-reevaluate", "description": "Operations addressed under `/customer-application-reevaluate` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "customer-applications", "description": "Operations addressed under `/customer-applications` — 7 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "customer-blockeds", "description": "Operations addressed under `/customer-blockeds` — 6 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "customer-groups", "description": "Operations addressed under `/customer-groups` — 6 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "customer-limit-assign", "description": "Operations addressed under `/customer-limit-assign` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "customer-loan-application-evaluate-ui-bpm", "description": "Operations addressed under `/customer-loan-application-evaluate-ui-bpm` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "customer-loan-campaigns", "description": "Operations addressed under `/customer-loan-campaigns` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "customer-loan-collections", "description": "Operations addressed under `/customer-loan-collections` — 13 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "customer-probability-defaults", "description": "Operations addressed under `/customer-probability-defaults` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "customer-risk-levels", "description": "Operations addressed under `/customer-risk-levels` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "customer-risks", "description": "Operations addressed under `/customer-risks` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "customer-rules", "description": "Operations addressed under `/customer-rules` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "customer-segments-range", "description": "Operations addressed under `/customer-segments-range` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "customer-virtual-transactions", "description": "Operations addressed under `/customer-virtual-transactions` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "customers", "description": "Operations addressed under `/customers` — 30 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "customers-with-contacts", "description": "Operations addressed under `/customers-with-contacts` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "data-securities", "description": "Operations addressed under `/data-securities` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "decision-definitions", "description": "Operations addressed under `/decision-definitions` — 3 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "decision-evaluations", "description": "Operations addressed under `/decision-evaluations` — 4 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "delete-customer-follow-dept-for-unfollowed-loans-bpmn", "description": "Operations addressed under `/delete-customer-follow-dept-for-unfollowed-loans-bpmn` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "delete-denomination-bpmn", "description": "Operations addressed under `/delete-denomination-bpmn` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "denomination-serial-number", "description": "Operations addressed under `/denomination-serial-number` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "denomination-transactions", "description": "Operations addressed under `/denomination-transactions` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "denominations", "description": "Operations addressed under `/denominations` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "deploy-process-definitions-by-ids", "description": "Operations addressed under `/deploy-process-definitions-by-ids` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "deploy-process-definitions-by-ui", "description": "Operations addressed under `/deploy-process-definitions-by-ui` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "distraint-collection", "description": "Operations addressed under `/distraint-collection` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "distraint-file-accounts", "description": "Operations addressed under `/distraint-file-accounts` — 2 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "distraint-process-reports", "description": "Operations addressed under `/distraint-process-reports` — 3 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "dms-map-items", "description": "Operations addressed under `/dms-map-items` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "dms-models", "description": "Operations addressed under `/dms-models` — 7 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "dms-queries", "description": "Operations addressed under `/dms-queries` — 9 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "document-items", "description": "Operations addressed under `/document-items` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "document-service-maps", "description": "Operations addressed under `/document-service-maps` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "documents", "description": "Operations addressed under `/documents` — 8 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "domain-caches", "description": "Operations addressed under `/domain-caches` — 3 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "domain-compensating-events", "description": "Operations addressed under `/domain-compensating-events` — 2 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "domain-data-migrations", "description": "Operations addressed under `/domain-data-migrations` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "domain-inbox-events", "description": "Operations addressed under `/domain-inbox-events` — 3 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "domain-key-formats", "description": "Operations addressed under `/domain-key-formats` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "domain-localizations", "description": "Operations addressed under `/domain-localizations` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "domain-matrix", "description": "Operations addressed under `/domain-matrix` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "domain-parameters", "description": "Operations addressed under `/domain-parameters` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "domains", "description": "Operations addressed under `/domains` — 4 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "easy-addresses", "description": "Operations addressed under `/easy-addresses` — 2 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "eledger-request", "description": "Operations addressed under `/eledger-request` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "eledger-requests", "description": "Operations addressed under `/eledger-requests` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "email-notifications", "description": "Operations addressed under `/email-notifications` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "events", "description": "Operations addressed under `/events` — 6 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "exchange-rates", "description": "Operations addressed under `/exchange-rates` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "expense-collections", "description": "Operations addressed under `/expense-collections` — 2 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "expense-items", "description": "Operations addressed under `/expense-items` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "expense-rules", "description": "Operations addressed under `/expense-rules` — 4 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "expenses", "description": "Operations addressed under `/expenses` — 2 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "external-service-definitions", "description": "Operations addressed under `/external-service-definitions` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "external-service-logs", "description": "Operations addressed under `/external-service-logs` — 2 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "external-services", "description": "Operations addressed under `/external-services` — 8 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "external-vendors", "description": "Operations addressed under `/external-vendors` — 14 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "fields", "description": "Operations addressed under `/fields` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "file-storages", "description": "Operations addressed under `/file-storages` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "file-transfers", "description": "Operations addressed under `/file-transfers` — 7 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "financial-statement-templates", "description": "Operations addressed under `/financial-statement-templates` — 7 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "financial-statements", "description": "Operations addressed under `/financial-statements` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "financial-transactions", "description": "Operations addressed under `/financial-transactions` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "fiscal-years", "description": "Operations addressed under `/fiscal-years` — 6 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "follow-send-sms", "description": "Operations addressed under `/follow-send-sms` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "follow-types", "description": "Operations addressed under `/follow-types` — 4 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "foreign-trade", "description": "Operations addressed under `/foreign-trade` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "forms", "description": "Operations addressed under `/forms` — 8 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "formulas", "description": "Operations addressed under `/formulas` — 6 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "formulas-details", "description": "Operations addressed under `/formulas-details` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "get-customer-info-by-citizenid", "description": "Operations addressed under `/get-customer-info-by-citizenid` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "get-mail-notifications", "description": "Operations addressed under `/get-mail-notifications` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "get-product-list-test-bpmn", "description": "Operations addressed under `/get-product-list-test-bpmn` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "get-sms-notifications", "description": "Operations addressed under `/get-sms-notifications` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "gl-code-formats", "description": "Operations addressed under `/gl-code-formats` — 3 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "gl-code-sections", "description": "Operations addressed under `/gl-code-sections` — 7 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "ibans", "description": "Operations addressed under `/ibans` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "identities", "description": "Operations addressed under `/identities` — 2 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "identity-types", "description": "Operations addressed under `/identity-types` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "import-lc-draft", "description": "Operations addressed under `/import-lc-draft` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "import-letter-credits", "description": "Operations addressed under `/import-letter-credits` — 7 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "incoming-distraint-files", "description": "Operations addressed under `/incoming-distraint-files` — 3 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "incoming-fasts", "description": "Operations addressed under `/incoming-fasts` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "incoming-letter-of-guarantees", "description": "Operations addressed under `/incoming-letter-of-guarantees` — 4 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "installment-delay-penalties", "description": "Operations addressed under `/installment-delay-penalties` — 2 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "integration-easy-addresses", "description": "Operations addressed under `/integration-easy-addresses` — 2 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "interbank", "description": "Operations addressed under `/interbank` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "interest-accruals", "description": "Operations addressed under `/interest-accruals` — 3 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "internal-vendors", "description": "Operations addressed under `/internal-vendors` — 8 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "key-formats", "description": "Operations addressed under `/key-formats` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "keycloak-logout", "description": "Operations addressed under `/keycloak-logout` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "kyc-references", "description": "Operations addressed under `/kyc-references` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "languages", "description": "Operations addressed under `/languages` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "ledger-balances", "description": "Operations addressed under `/ledger-balances` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "ledger-code-matrix", "description": "Operations addressed under `/ledger-code-matrix` — 7 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "ledger-code-matrix-fields", "description": "Operations addressed under `/ledger-code-matrix-fields` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "ledger-code-matrix-values", "description": "Operations addressed under `/ledger-code-matrix-values` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "ledger-level-format", "description": "Operations addressed under `/ledger-level-format` — 2 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "ledger-level-formats", "description": "Operations addressed under `/ledger-level-formats` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "ledger-matrix", "description": "Operations addressed under `/ledger-matrix` — 2 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "ledgers", "description": "Operations addressed under `/ledgers` — 6 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "legal-follows", "description": "Operations addressed under `/legal-follows` — 2 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "limit-items", "description": "Operations addressed under `/limit-items` — 7 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "loan", "description": "Operations addressed under `/loan` — 28 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "loan-campaigns", "description": "Operations addressed under `/loan-campaigns` — 4 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "loan-collection", "description": "Operations addressed under `/loan-collection` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "loan-collections", "description": "Operations addressed under `/loan-collections` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "loan-payout-reservations", "description": "Operations addressed under `/loan-payout-reservations` — 2 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "loan-reconciliations", "description": "Operations addressed under `/loan-reconciliations` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "loans", "description": "Operations addressed under `/loans` — 44 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "localization-types", "description": "Operations addressed under `/localization-types` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "mail-notifications", "description": "Operations addressed under `/mail-notifications` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "main-prices", "description": "Operations addressed under `/main-prices` — 6 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "main-products", "description": "Operations addressed under `/main-products` — 6 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "mask-formats", "description": "Operations addressed under `/mask-formats` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "matrix", "description": "Operations addressed under `/matrix` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "menus", "description": "Operations addressed under `/menus` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "money-transfer-to-other-account", "description": "Operations addressed under `/money-transfer-to-other-account` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "money-transfer-to-other-bank", "description": "Operations addressed under `/money-transfer-to-other-bank` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "money-transfer-to-own-account", "description": "Operations addressed under `/money-transfer-to-own-account` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "naces", "description": "Operations addressed under `/naces` — 3 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "notification-providers", "description": "Operations addressed under `/notification-providers` — 2 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "occupation-types", "description": "Operations addressed under `/occupation-types` — 13 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "organizations", "description": "Operations addressed under `/organizations` — 11 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "otp-items", "description": "Operations addressed under `/otp-items` — 10 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "outgoing-distraint-files", "description": "Operations addressed under `/outgoing-distraint-files` — 4 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "outgoing-letter-of-guarantees", "description": "Operations addressed under `/outgoing-letter-of-guarantees` — 4 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "parameters", "description": "Operations addressed under `/parameters` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "partners", "description": "Operations addressed under `/partners` — 6 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "password-policies", "description": "Operations addressed under `/password-policies` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "payback-plans", "description": "Operations addressed under `/payback-plans` — 6 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "permissions", "description": "Operations addressed under `/permissions` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "person-address-registrations", "description": "Operations addressed under `/person-address-registrations` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "person-registrations", "description": "Operations addressed under `/person-registrations` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "person-risk-levels", "description": "Operations addressed under `/person-risk-levels` — 4 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "pool-definitions", "description": "Operations addressed under `/pool-definitions` — 2 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "position-accounts", "description": "Operations addressed under `/position-accounts` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "process-definition-drafts", "description": "Operations addressed under `/process-definition-drafts` — 4 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "process-definitions", "description": "Operations addressed under `/process-definitions` — 14 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "process-domain-inbox-event-list", "description": "Operations addressed under `/process-domain-inbox-event-list` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "process-instances", "description": "Operations addressed under `/process-instances` — 8 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "product-categories", "description": "Operations addressed under `/product-categories` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "product-groups", "description": "Operations addressed under `/product-groups` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "products", "description": "Operations addressed under `/products` — 10 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "products-by-customer-cash-type", "description": "Operations addressed under `/products-by-customer-cash-type` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "proposals", "description": "Operations addressed under `/proposals` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "provisions", "description": "Operations addressed under `/provisions` — 2 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "pwf-change-user-password", "description": "Operations addressed under `/pwf-change-user-password` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "pwf-create-document", "description": "Operations addressed under `/pwf-create-document` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "pwf-verify-and-login", "description": "Operations addressed under `/pwf-verify-and-login` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "queries", "description": "Operations addressed under `/queries` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "realms", "description": "Operations addressed under `/realms` — 2 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "redirect", "description": "Operations addressed under `/redirect` — 2 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "requirement-configs", "description": "Operations addressed under `/requirement-configs` — 3 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "reserved-customers", "description": "Operations addressed under `/reserved-customers` — 3 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "risk-definitions", "description": "Operations addressed under `/risk-definitions` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "risk-ledgers", "description": "Operations addressed under `/risk-ledgers` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "risks", "description": "Operations addressed under `/risks` — 3 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "roles", "description": "Operations addressed under `/roles` — 8 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "save-and-read-prepaid-transactions-scheduler-bpmn", "description": "Operations addressed under `/save-and-read-prepaid-transactions-scheduler-bpmn` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "saved-transactions", "description": "Operations addressed under `/saved-transactions` — 2 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "send-bulk-sms-bpm", "description": "Operations addressed under `/send-bulk-sms-bpm` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "send-otp-for-login", "description": "Operations addressed under `/send-otp-for-login` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "send-otp-for-reset", "description": "Operations addressed under `/send-otp-for-reset` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "send-sms-otp", "description": "Operations addressed under `/send-sms-otp` — 2 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "service-logs", "description": "Operations addressed under `/service-logs` — 2 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "services", "description": "Operations addressed under `/services` — 7 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "services-bpmn", "description": "Operations addressed under `/services-bpmn` — 4 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "slip-transactions", "description": "Operations addressed under `/slip-transactions` — 6 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "slips", "description": "Operations addressed under `/slips` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "sms-notifications", "description": "Operations addressed under `/sms-notifications` — 2 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "tax-offices", "description": "Operations addressed under `/tax-offices` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "taxes", "description": "Operations addressed under `/taxes` — 8 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "template-types", "description": "Operations addressed under `/template-types` — 20 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "tenants", "description": "Operations addressed under `/tenants` — 4 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "test-dist-event-bpm", "description": "Operations addressed under `/test-dist-event-bpm` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "testurlpath", "description": "Operations addressed under `/testurlpath` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "throw-distirubted-events-bpm", "description": "Operations addressed under `/throw-distirubted-events-bpm` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "time-deposits", "description": "Operations addressed under `/time-deposits` — 3 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "trial-balance", "description": "Operations addressed under `/trial-balance` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "unlimited-company-customers", "description": "Operations addressed under `/unlimited-company-customers` — 3 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "update-denomination-bpmn", "description": "Operations addressed under `/update-denomination-bpmn` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "update-eledger-request-bpmn", "description": "Operations addressed under `/update-eledger-request-bpmn` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "update-eledger-request-status-bpmn", "description": "Operations addressed under `/update-eledger-request-status-bpmn` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "update-potential-user", "description": "Operations addressed under `/update-potential-user` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "update-price-rate-sync-process-bpmn", "description": "Operations addressed under `/update-price-rate-sync-process-bpmn` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "user-devices", "description": "Operations addressed under `/user-devices` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "user-favorites", "description": "Operations addressed under `/user-favorites` — 3 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "user-notifications", "description": "Operations addressed under `/user-notifications` — 4 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "user-tasks", "description": "Operations addressed under `/user-tasks` — 8 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "users", "description": "Operations addressed under `/users` — 22 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "validate-citizenid-tax", "description": "Operations addressed under `/validate-citizenid-tax` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "validate-iban", "description": "Operations addressed under `/validate-iban` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "validations", "description": "Operations addressed under `/validations` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "verify-customer", "description": "Operations addressed under `/verify-customer` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "verify-customer-emlak", "description": "Operations addressed under `/verify-customer-emlak` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "verify-otp-and-create-potential-user-bpm", "description": "Operations addressed under `/verify-otp-and-create-potential-user-bpm` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "workflow-history", "description": "Operations addressed under `/workflow-history` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } ], "paths": { "/account-cash-transactions": { "get": { "operationId": "aurax-bff-service-dynamic-get-money-transfer-list", "tags": [ "account-cash-transactions" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-get-money-transfer-list", "description": "Request and response fields are declared on the routing target `get-money-transfer-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "accountingEntryId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryId" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "cashTransactionType": { "type": "integer", "format": "int32", "x-aura-field-code": "cashTransactionType" }, "createdDate": { "type": "string", "format": "date-time", "x-aura-field-code": "createdDate" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "description": { "type": "string", "x-aura-field-code": "description" }, "fromAccountId": { "type": "string", "format": "uuid", "x-aura-field-code": "fromAccountId" }, "operationType": { "type": "integer", "format": "int32", "x-aura-field-code": "operationType" }, "toAccountId": { "type": "string", "format": "uuid", "x-aura-field-code": "toAccountId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-get-money-transfer-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "account-cash-transactions", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-money-transfer-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "MoneyTransferDto", "collection": true, "members": [ { "name": "FromAccountId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ToAccountId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Amount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OperationType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "AccountingEntryId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CashTransactionType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CreatedDate", "declared_type": "DateTime", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/account-cash-transactions-old": { "get": { "operationId": "aurax-bff-redirect-get-money-transfer-list", "tags": [ "account-cash-transactions-old" ], "summary": "aurax-bff-redirect-get-money-transfer-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. It returns a page of records under `data`, with `total` carrying the unpaged count — but the record's fields are not declared.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-money-transfer-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "account-cash-transactions-old", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/account-cash-transactions/cash-deposit": { "post": { "operationId": "aurax-bff-redirect-cash-deposit-ui", "tags": [ "account-cash-transactions" ], "summary": "aurax-bff-redirect-cash-deposit-ui", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-cash-deposit-ui", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "account-cash-transactions/cash-deposit", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/account-cash-transactions/cash-withdrawal": { "post": { "operationId": "aurax-bff-redirect-cash-withdraw-ui", "tags": [ "account-cash-transactions" ], "summary": "aurax-bff-redirect-cash-withdraw-ui", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-cash-withdraw-ui", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "account-cash-transactions/cash-withdrawal", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/account-product-rules": { "get": { "operationId": "aurax-bff-dynamic-get-account-product-rule-list", "tags": [ "account-product-rules" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-account-product-rule-list", "description": "Request and response fields are declared on the routing target `get-account-product-rule-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "accountProductRuleMaps": { "type": "array", "items": { "type": "object", "properties": { "accountProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductId" }, "accountProductRuleId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductRuleId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } }, "x-aura-field-code": "accountProductRuleMaps" } }, "beginDate": { "type": "string", "format": "date-time", "x-aura-field-code": "beginDate" }, "code": { "type": "string", "x-aura-field-code": "code" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "formulaDefinitionId": { "type": "string", "format": "uuid", "x-aura-field-code": "formulaDefinitionId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "ruleType": { "type": "integer", "format": "int32", "x-aura-field-code": "ruleType" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-account-product-rule-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "account-product-rules", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-account-product-rule-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "AccountProductRuleDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FormulaDefinitionId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "BeginDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "EndDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "RuleType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "AccountProductRuleMaps", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-account-product-rule-list", "target_dapr_app_id": "account-service", "target_route": "account-product-rules", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-dynamic-create-account-product-rule-ui-bpm", "tags": [ "account-product-rules" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-create-account-product-rule-ui-bpm", "description": "Request and response fields are declared on the routing target `create-account-product-rule-ui-bpm`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "beginDate": { "type": "string", "format": "date-time", "x-aura-field-code": "beginDate" }, "code": { "type": "string", "x-aura-field-code": "ruleCode" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "formula": { "type": "string", "x-aura-field-code": "formula" }, "ruleType": { "type": "integer", "format": "int32", "x-aura-field-code": "ruleType" } }, "required": [ "code", "formula", "ruleType" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 5, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-create-account-product-rule-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "account-product-rules", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/account-product-rules/{id}": { "delete": { "operationId": "aurax-bff-dynamic-delete-account-product-rule", "tags": [ "account-product-rules" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-delete-account-product-rule", "description": "Request and response fields are declared on the routing target `delete-account-product-rule`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-delete-account-product-rule", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "account-product-rules/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "forwarded": { "service_code": "delete-account-product-rule", "target_dapr_app_id": "account-service", "target_route": "account-product-rules/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCNT_109", "status": 400, "message": { "ar": "لم يتم العثور على قاعدة حساب المنتج.", "en": "Account product rule not found.", "tr": "Hesap ürünü kuralı bulunamadı." }, "message_available": true, "constant_name": "ACCOUNT_PRODUCT_RULE_NOT_FOUND" }, { "code": "ERR_ACCNT_113", "status": 400, "message": { "ar": "قاعدة حساب المنتج لا يمكن حذفها، فهي قيد الاستخدام على منتج حساب.", "en": "Account product rule cannot be deleted, it is being used on an account product.", "tr": "Hesap ürünü kuralı silinemaz, bir hesap ürününde kullanılıyor." }, "message_available": true, "constant_name": "ACCOUNT_PRODUCT_RULE_CANNOT_BE_DELETED_IT_IS_USING_ON_ACCOUNT_PRODUCT" } ] } }, "get": { "operationId": "aurax-bff-dynamic-get-account-product-rule-by-id", "tags": [ "account-product-rules" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-account-product-rule-by-id", "description": "Request and response fields are declared on the routing target `get-account-product-rule-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "accountProductRuleMaps": { "type": "array", "items": { "type": "object", "properties": { "accountProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductId" }, "accountProductRuleId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductRuleId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } }, "x-aura-field-code": "accountProductRuleMaps" } }, "beginDate": { "type": "string", "format": "date-time", "x-aura-field-code": "beginDate" }, "code": { "type": "string", "x-aura-field-code": "code" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "formulaDefinitionId": { "type": "string", "format": "uuid", "x-aura-field-code": "formulaDefinitionId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "ruleType": { "type": "integer", "format": "int32", "x-aura-field-code": "ruleType" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-account-product-rule-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "account-product-rules/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "AccountProductRuleDto", "payload": "AccountProductRuleDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FormulaDefinitionId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "BeginDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "EndDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "RuleType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "AccountProductRuleMaps", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-account-product-rule-by-id", "target_dapr_app_id": "account-service", "target_route": "account-product-rules/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCNT_109", "status": 400, "message": { "ar": "لم يتم العثور على قاعدة حساب المنتج.", "en": "Account product rule not found.", "tr": "Hesap ürünü kuralı bulunamadı." }, "message_available": true, "constant_name": "ACCOUNT_PRODUCT_RULE_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-dynamic-edit-account-product-rule-ui-bpm", "tags": [ "account-product-rules" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-edit-account-product-rule-ui-bpm", "description": "Request and response fields are declared on the routing target `edit-account-product-rule-ui-bpm`; this entry declares none of its own.\n\nDeclared as Route-bound but absent from the route template, so not sendable: formulaDefinitionId.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductRuleId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "beginDate": { "type": "string", "format": "date-time", "x-aura-field-code": "beginDate" }, "code": { "type": "string", "x-aura-field-code": "ruleCode" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "formula": { "type": "string", "x-aura-field-code": "formula" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "ruleType": { "type": "integer", "format": "int32", "x-aura-field-code": "ruleType" } }, "required": [ "code", "formula", "isActive", "ruleType" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 6, "claim": 0, "form": 0, "header": 0, "path": 2, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-edit-account-product-rule-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "account-product-rules/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/account-product-rules/{id}/maps": { "get": { "operationId": "aurax-bff-dynamic-get-account-product-rule-map-list", "tags": [ "account-product-rules" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-account-product-rule-map-list", "description": "Request and response fields are declared on the routing target `get-account-product-rule-map-list`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "code" }, "expression": { "type": "string", "x-aura-field-code": "expression" } }, "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "accountProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductId" }, "accountProductRuleId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductRuleId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-account-product-rule-map-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "account-product-rules/{id}/maps", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-account-product-rule-map-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "AccountProductRuleMapDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AccountProductId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "AccountProductRuleId", "declared_type": "Guid?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-account-product-rule-map-list", "target_dapr_app_id": "account-service", "target_route": "account-product-rules/{id}/maps", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCNT_109", "status": 400, "message": { "ar": "لم يتم العثور على قاعدة حساب المنتج.", "en": "Account product rule not found.", "tr": "Hesap ürünü kuralı bulunamadı." }, "message_available": true, "constant_name": "ACCOUNT_PRODUCT_RULE_NOT_FOUND" } ] } } }, "/account-product-rules/{id}/maps/{mapId}": { "get": { "operationId": "aurax-bff-dynamic-get-account-product-rule-map-by-id", "tags": [ "account-product-rules" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-account-product-rule-map-by-id", "description": "Request and response fields are declared on the routing target `get-account-product-rule-map-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } }, { "name": "mapId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "mapId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 2, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "accountProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductId" }, "accountProductRuleId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductRuleId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-account-product-rule-map-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "account-product-rules/{id}/maps/{mapId}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "AccountProductRuleMapDto", "payload": "AccountProductRuleMapDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AccountProductId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "AccountProductRuleId", "declared_type": "Guid?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-account-product-rule-map-by-id", "target_dapr_app_id": "account-service", "target_route": "account-product-rules/{id}/maps/{mapId}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCNT_109", "status": 400, "message": { "ar": "لم يتم العثور على قاعدة حساب المنتج.", "en": "Account product rule not found.", "tr": "Hesap ürünü kuralı bulunamadı." }, "message_available": true, "constant_name": "ACCOUNT_PRODUCT_RULE_NOT_FOUND" }, { "code": "ERR_ACCNT_110", "status": 400, "message": { "ar": "لم يتم العثور على خريطة قاعدة منتج الحساب.", "en": "Account product rule map not found.", "tr": "Hesap ürünü kuralı haritası bulunamadı." }, "message_available": true, "constant_name": "ACCOUNT_PRODUCT_RULE_MAP_NOT_FOUND" } ] } } }, "/account-products": { "get": { "operationId": "aurax-bff-dynamic-get-account-product-list", "tags": [ "account-products" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-account-product-list", "description": "Request and response fields are declared on the routing target `get-account-product-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "accountProductConfigs": { "type": "array", "items": { "type": "object", "properties": { "customerType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerType" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductConfigId" } }, "x-aura-field-code": "accountProductConfigs" } }, "accountProductContributions": { "type": "array", "items": { "type": "object", "properties": { "accountProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductId" }, "accountProductTaxes": { "type": "array", "items": { "type": "object", "properties": { "accountProductContributionId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductContributionId" }, "accountProductTaxesId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductTaxesId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductTaxId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "taxId": { "type": "string", "format": "uuid", "x-aura-field-code": "taxId" } }, "x-aura-field-code": "accountProductTaxes" } }, "contributionRate": { "type": "number", "format": "decimal", "x-aura-field-code": "contributionRate" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductContributionId" }, "maturityUnit": { "type": "integer", "format": "int32", "x-aura-field-code": "maturityUnit" }, "maxAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "maxAmount" }, "maxMaturity": { "type": "integer", "format": "int32", "x-aura-field-code": "maxMaturity" }, "minAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "minAmount" }, "minMaturity": { "type": "integer", "format": "int32", "x-aura-field-code": "minMaturity" } }, "x-aura-field-code": "accountProductContributions" } }, "accountProductConvertibleCurrencies": { "type": "array", "items": { "type": "object", "properties": { "accountProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductId" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "exchangeSpreadType": { "type": "integer", "format": "int32", "x-aura-field-code": "exchangeSpreadType" } }, "x-aura-field-code": "accountProductConvertibleCurrencies" } }, "accountProductException": { "type": "object", "properties": { "accountProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductExceptionId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "rate": { "type": "number", "format": "decimal", "x-aura-field-code": "rate" } }, "x-aura-field-code": "accountProductException" }, "accountProductType": { "type": "integer", "format": "int32", "x-aura-field-code": "accountProductType" }, "balanceControlEndTime": { "type": "string", "format": "time", "x-aura-field-code": "balanceControlEndTime" }, "balanceControlStartTime": { "type": "string", "format": "time", "x-aura-field-code": "balanceControlStartTime" }, "code": { "type": "string", "x-aura-field-code": "accountProductCode" }, "contributionCalculateType": { "type": "integer", "format": "int32", "x-aura-field-code": "contributionCalculateType" }, "description": { "type": "string", "x-aura-field-code": "description" }, "extensionDay": { "type": "integer", "format": "int32", "x-aura-field-code": "extensionDay" }, "extensionType": { "type": "integer", "format": "int32", "x-aura-field-code": "extensionType" }, "hasMaturity": { "type": "boolean", "x-aura-field-code": "hasMaturity" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductId" }, "interimContributionPayment": { "type": "integer", "format": "int32", "x-aura-field-code": "interimContributionPayment" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "isAutoRenewal": { "type": "boolean", "x-aura-field-code": "isAutoRenewal" }, "isDeposited": { "type": "boolean", "x-aura-field-code": "isDeposited" }, "isDirectMoneyOutflow": { "type": "boolean", "x-aura-field-code": "isDirectMoneyOutflow" }, "isInterimContributionPayment": { "type": "boolean", "x-aura-field-code": "isInterimContributionPayment" }, "isLeafLevel": { "type": "boolean", "x-aura-field-code": "isLeafLevel" }, "isMaturityToFirstWorkday": { "type": "boolean", "x-aura-field-code": "isMaturityToFirstWorkday" }, "isRegularPaymentMandatory": { "type": "boolean", "x-aura-field-code": "isRegularPaymentMandatory" }, "isSpecialRateAvailable": { "type": "boolean", "x-aura-field-code": "isSpecialRateAvailable" }, "isWithdrawn": { "type": "boolean", "x-aura-field-code": "isWithdrawn" }, "maxSpecialRate": { "type": "number", "format": "decimal", "x-aura-field-code": "maxSpecialRate" }, "minSpecialRate": { "type": "number", "format": "decimal", "x-aura-field-code": "minSpecialRate" }, "minimumMaturityForPenaltyFreeWithdrawal": { "type": "integer", "format": "int32", "x-aura-field-code": "minimumMaturityForPenaltyFreeWithdrawal" }, "name": { "type": "string", "x-aura-field-code": "accountProductName" }, "parentAccountProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "parentAccountProductId" }, "regularDepositPeriodicity": { "type": "integer", "format": "int32", "x-aura-field-code": "regularDepositPeriodicity" }, "valueDay": { "type": "integer", "format": "int32", "x-aura-field-code": "valueDay" }, "valueStartDay": { "type": "integer", "format": "int32", "x-aura-field-code": "valueStartDay" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-account-product-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "account-products", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-account-product-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "unresolved", "note": "The repository declares `AccountProductDto` 2 times and nothing in the route expression says which one. No structure is published rather than one picked at random.", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "AccountProductDto", "forwarded": { "service_code": "get-account-product-list", "target_dapr_app_id": "account-service", "target_route": "account-products", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-dynamic-account-product-create-ui-bpm", "tags": [ "account-products" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "account-product-create-ui-bpm", "description": "Invokes the `aurax-bff-dynamic-account-product-create-ui-bpm` service definition through `POST /account-products`.\n\nRequest and response fields are declared on the routing target `account-product-create-ui-bpm`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "accountProductConfigs": { "type": "array", "items": { "type": "object", "properties": { "customerType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerType" } }, "required": [ "customerType" ], "x-aura-field-code": "accountProductConfigs" } }, "accountProductContributions": { "type": "array", "items": { "type": "object", "properties": { "accountProductTaxes": { "type": "array", "items": { "type": "object", "properties": { "taxId": { "type": "string", "format": "uuid", "x-aura-field-code": "taxId" } }, "x-aura-field-code": "accountProductTaxes" } }, "accountProductTransactionLimits": { "type": "array", "items": { "type": "object", "properties": { "cashTransactionType": { "type": "integer", "format": "int32", "x-aura-field-code": "cashTransactionType" }, "maxAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "maxAmount" }, "maxRate": { "type": "number", "format": "decimal", "x-aura-field-code": "maxRate" }, "minAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "minAmount" }, "minRate": { "type": "number", "format": "decimal", "x-aura-field-code": "minRate" } }, "x-aura-field-code": "accountProductTransactionLimits" } }, "beginDate": { "type": "string", "format": "date-time", "x-aura-field-code": "beginDate" }, "contributionRate": { "type": "number", "format": "decimal", "x-aura-field-code": "contributionRate" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "maturityUnit": { "type": "integer", "format": "int32", "x-aura-field-code": "maturityUnit" }, "maxAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "maxAmount" }, "maxBalance": { "type": "number", "format": "decimal", "x-aura-field-code": "maxBalance" }, "maxMaturity": { "type": "integer", "format": "int32", "x-aura-field-code": "maxMaturity" }, "minAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "minAmount" }, "minBalance": { "type": "number", "format": "decimal", "x-aura-field-code": "minBalance" }, "minMaturity": { "type": "integer", "format": "int32", "x-aura-field-code": "minMaturity" } }, "x-aura-field-code": "accountProductContributions" } }, "accountProductConvertibleCurrencies": { "type": "array", "items": { "type": "object", "properties": { "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "exchangeSpreadType": { "type": "integer", "format": "int32", "x-aura-field-code": "exchangeSpreadType" } }, "x-aura-field-code": "accountProductConvertibleCurrencies" } }, "accountProductRuleMaps": { "type": "array", "items": { "type": "object", "properties": { "accountProductRuleId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductRuleId" } }, "x-aura-field-code": "accountProductRuleMaps" } }, "accountProductType": { "type": "integer", "format": "int32", "x-aura-field-code": "accountProductType" }, "balanceControlEndTime": { "type": "string", "format": "time", "x-aura-field-code": "balanceControlEndTime" }, "balanceControlStartTime": { "type": "string", "format": "time", "x-aura-field-code": "balanceControlStartTime" }, "code": { "type": "string", "x-aura-field-code": "accountProductCode" }, "contributionCalculateType": { "type": "integer", "format": "int32", "x-aura-field-code": "contributionCalculateType" }, "description": { "type": "string", "x-aura-field-code": "description" }, "hasMaturity": { "type": "boolean", "x-aura-field-code": "hasMaturity" }, "interimContributionPayment": { "type": "integer", "format": "int32", "x-aura-field-code": "interimContributionPayment" }, "isAutoRenewal": { "type": "boolean", "x-aura-field-code": "isAutoRenewal" }, "isDeposited": { "type": "boolean", "x-aura-field-code": "isDeposited" }, "isDirectMoneyOutflow": { "type": "boolean", "x-aura-field-code": "isDirectMoneyOutflow" }, "isInterimContributionPayment": { "type": "boolean", "x-aura-field-code": "isInterimContributionPayment" }, "isMaturityToFirstWorkday": { "type": "boolean", "x-aura-field-code": "isMaturityToFirstWorkday" }, "isRegularPaymentMandatory": { "type": "boolean", "x-aura-field-code": "isRegularPaymentMandatory" }, "isSpecialRateAvailable": { "type": "boolean", "x-aura-field-code": "isSpecialRateAvailable" }, "isWithdrawn": { "type": "boolean", "x-aura-field-code": "isWithdrawn" }, "maxSpecialRate": { "type": "number", "format": "decimal", "x-aura-field-code": "maxSpecialRate" }, "minSpecialRate": { "type": "number", "format": "decimal", "x-aura-field-code": "minSpecialRate" }, "minimumMaturityForPenaltyFreeWithdrawal": { "type": "integer", "format": "int32", "x-aura-field-code": "minimumMaturityForPenaltyFreeWithdrawal" }, "name": { "type": "string", "x-aura-field-code": "accountProductName" }, "parentAccountProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "parentAccountProductId" }, "regularDepositPeriodicity": { "type": "integer", "format": "int32", "x-aura-field-code": "regularDepositPeriodicity" }, "valueDay": { "type": "integer", "format": "int32", "x-aura-field-code": "valueDay" }, "valueStartDay": { "type": "integer", "format": "int32", "x-aura-field-code": "valueStartDay" } }, "required": [ "accountProductConfigs", "accountProductType", "code", "description", "name" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 28, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-account-product-create-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "account-products", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/account-products/{id}": { "delete": { "operationId": "aurax-bff-dynamic-account-product-delete-ui-bpm", "tags": [ "account-products" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "account-product-delete-ui-bpm", "description": "Invokes the `aurax-bff-dynamic-account-product-delete-ui-bpm` service definition through `DELETE /account-products/{id}`.\n\nRequest and response fields are declared on the routing target `account-product-delete-ui-bpm`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductId" } } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-account-product-delete-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "account-products/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "get": { "operationId": "aurax-bff-dynamic-get-account-product-by-id", "tags": [ "account-products" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-account-product-by-id", "description": "Request and response fields are declared on the routing target `get-account-product-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "accountProductConfigs": { "type": "array", "items": { "type": "object", "properties": { "customerType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerType" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductConfigId" } }, "x-aura-field-code": "accountProductConfigs" } }, "accountProductContributions": { "type": "array", "items": { "type": "object", "properties": { "accountProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductId" }, "accountProductTaxes": { "type": "array", "items": { "type": "object", "properties": { "accountProductContributionId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductContributionId" }, "accountProductTaxesId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductTaxesId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductTaxId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "taxId": { "type": "string", "format": "uuid", "x-aura-field-code": "taxId" } }, "x-aura-field-code": "accountProductTaxes" } }, "accountProductTransactionLimits": { "type": "array", "items": { "type": "object", "properties": { "accountProductContributionId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductContributionId" }, "cashTransactionType": { "type": "integer", "format": "int32", "x-aura-field-code": "cashTransactionType" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "transactionLimitId" }, "maxAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "maxAmount" }, "maxRate": { "type": "number", "format": "decimal", "x-aura-field-code": "maxRate" }, "minAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "minAmount" }, "minRate": { "type": "number", "format": "decimal", "x-aura-field-code": "minRate" } }, "x-aura-field-code": "accountProductTransactionLimits" } }, "beginDate": { "type": "string", "format": "date-time", "x-aura-field-code": "beginDate" }, "contributionRate": { "type": "number", "format": "decimal", "x-aura-field-code": "contributionRate" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductContributionId" }, "maturityUnit": { "type": "integer", "format": "int32", "x-aura-field-code": "maturityUnit" }, "maxAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "maxAmount" }, "maxBalance": { "type": "number", "format": "decimal", "x-aura-field-code": "maxBalance" }, "maxMaturity": { "type": "integer", "format": "int32", "x-aura-field-code": "maxMaturity" }, "minAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "minAmount" }, "minBalance": { "type": "number", "format": "decimal", "x-aura-field-code": "minBalance" }, "minMaturity": { "type": "integer", "format": "int32", "x-aura-field-code": "minMaturity" } }, "x-aura-field-code": "accountProductContributions" } }, "accountProductConvertibleCurrencies": { "type": "array", "items": { "type": "object", "properties": { "accountProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductId" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "exchangeSpreadType": { "type": "integer", "format": "int32", "x-aura-field-code": "exchangeSpreadType" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "convertibleCurrencyId" } }, "x-aura-field-code": "accountProductConvertibleCurrencies" } }, "accountProductException": { "type": "object", "properties": { "accountProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductExceptionId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "rate": { "type": "number", "format": "decimal", "x-aura-field-code": "rate" } }, "x-aura-field-code": "accountProductException" }, "accountProductRuleMaps": { "type": "array", "items": { "type": "object", "properties": { "accountProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductId" }, "accountProductRuleId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductRuleId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductRuleMapId" } }, "x-aura-field-code": "accountProductRuleMaps" } }, "accountProductType": { "type": "integer", "format": "int32", "x-aura-field-code": "accountProductType" }, "balanceControlEndTime": { "type": "string", "format": "time", "x-aura-field-code": "balanceControlEndTime" }, "balanceControlStartTime": { "type": "string", "format": "time", "x-aura-field-code": "balanceControlStartTime" }, "code": { "type": "string", "x-aura-field-code": "accountProductCode" }, "contributionCalculateType": { "type": "integer", "format": "int32", "x-aura-field-code": "contributionCalculateType" }, "description": { "type": "string", "x-aura-field-code": "description" }, "extensionDay": { "type": "integer", "format": "int32", "x-aura-field-code": "extensionDay" }, "extensionType": { "type": "integer", "format": "int32", "x-aura-field-code": "extensionType" }, "hasMaturity": { "type": "boolean", "x-aura-field-code": "hasMaturity" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductId" }, "interimContributionPayment": { "type": "integer", "format": "int32", "x-aura-field-code": "interimContributionPayment" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "isAutoRenewal": { "type": "boolean", "x-aura-field-code": "isAutoRenewal" }, "isDeposited": { "type": "boolean", "x-aura-field-code": "isDeposited" }, "isDirectMoneyOutflow": { "type": "boolean", "x-aura-field-code": "isDirectMoneyOutflow" }, "isInterimContributionPayment": { "type": "boolean", "x-aura-field-code": "isInterimContributionPayment" }, "isLeafLevel": { "type": "boolean", "x-aura-field-code": "isLeafLevel" }, "isMaturityToFirstWorkday": { "type": "boolean", "x-aura-field-code": "isMaturityToFirstWorkday" }, "isRegularPaymentMandatory": { "type": "boolean", "x-aura-field-code": "isRegularPaymentMandatory" }, "isSpecialRateAvailable": { "type": "boolean", "x-aura-field-code": "isSpecialRateAvailable" }, "isWithdrawn": { "type": "boolean", "x-aura-field-code": "isWithdrawn" }, "maxSpecialRate": { "type": "number", "format": "decimal", "x-aura-field-code": "maxSpecialRate" }, "minSpecialRate": { "type": "number", "format": "decimal", "x-aura-field-code": "minSpecialRate" }, "minimumMaturityForPenaltyFreeWithdrawal": { "type": "integer", "format": "int32", "x-aura-field-code": "minimumMaturityForPenaltyFreeWithdrawal" }, "name": { "type": "string", "x-aura-field-code": "accountProductName" }, "parentAccountProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "parentAccountProductId" }, "regularDepositPeriodicity": { "type": "integer", "format": "int32", "x-aura-field-code": "regularDepositPeriodicity" }, "valueDay": { "type": "integer", "format": "int32", "x-aura-field-code": "valueDay" }, "valueStartDay": { "type": "integer", "format": "int32", "x-aura-field-code": "valueStartDay" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-account-product-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "account-products/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "unresolved", "note": "The repository declares `AccountProductDto` 2 times and nothing in the route expression says which one. No structure is published rather than one picked at random.", "declared_type": "AccountProductDto", "payload": "AccountProductDto", "forwarded": { "service_code": "get-account-product-by-id", "target_dapr_app_id": "account-service", "target_route": "account-products/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "put": { "operationId": "aurax-bff-dynamic-account-product-edit-ui-bpm", "tags": [ "account-products" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "account-product-edit-ui-bpm", "description": "Invokes the `aurax-bff-dynamic-account-product-edit-ui-bpm` service definition through `PUT /account-products/{id}`.\n\nRequest and response fields are declared on the routing target `account-product-edit-ui-bpm`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in this route template but not among the Route-bound fields of the routing target `account-product-edit-ui-bpm`, whose own path is decoupled from this one.", "x-aura-source": "route-template-only-after-collapse" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "accountProductConfigs": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "customerType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerType" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "configId" } }, "required": [ "customerType" ], "x-aura-field-code": "accountProductConfigs" } }, "accountProductContributions": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "accountProductTaxes": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductTaxId" }, "taxId": { "type": "string", "format": "uuid", "x-aura-field-code": "taxId" } }, "x-aura-field-code": "accountProductTaxes" } }, "accountProductTransactionLimits": { "type": "array", "items": { "type": "object", "properties": { "cashTransactionType": { "type": "integer", "format": "int32", "x-aura-field-code": "cashTransactionType" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "transactionLimitId" }, "maxAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "maxAmount" }, "maxRate": { "type": "number", "format": "decimal", "x-aura-field-code": "maxRate" }, "minAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "minAmount" }, "minRate": { "type": "number", "format": "decimal", "x-aura-field-code": "minRate" } }, "x-aura-field-code": "accountProductTransactionLimits" } }, "beginDate": { "type": "string", "format": "date-time", "x-aura-field-code": "beginDate" }, "contributionId": { "type": "string", "format": "uuid", "x-aura-field-code": "contributionId" }, "contributionRate": { "type": "number", "format": "decimal", "x-aura-field-code": "contributionRate" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "maturityUnit": { "type": "integer", "format": "int32", "x-aura-field-code": "maturityUnit" }, "maxAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "maxAmount" }, "maxBalance": { "type": "number", "format": "decimal", "x-aura-field-code": "maxBalance" }, "maxMaturity": { "type": "integer", "format": "int32", "x-aura-field-code": "maxMaturity" }, "minAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "minAmount" }, "minBalance": { "type": "number", "format": "decimal", "x-aura-field-code": "minBalance" }, "minMaturity": { "type": "integer", "format": "int32", "x-aura-field-code": "minMaturity" } }, "x-aura-field-code": "accountProductContributions" } }, "accountProductConvertibleCurrencies": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "exchangeSpreadType": { "type": "integer", "format": "int32", "x-aura-field-code": "exchangeSpreadType" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "convertibleCurrencyId" } }, "x-aura-field-code": "accountProductConvertibleCurrencies" } }, "accountProductRuleMaps": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "accountProductRuleId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductRuleId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductRuleMapId" } }, "x-aura-field-code": "accountProductRuleMaps" } }, "accountProductType": { "type": "integer", "format": "int32", "x-aura-field-code": "accountProductType" }, "balanceControlEndTime": { "type": "string", "format": "time", "x-aura-field-code": "balanceControlEndTime" }, "balanceControlStartTime": { "type": "string", "format": "time", "x-aura-field-code": "balanceControlStartTime" }, "code": { "type": "string", "x-aura-field-code": "accountProductCode" }, "contributionCalculateType": { "type": "integer", "format": "int32", "x-aura-field-code": "contributionCalculateType" }, "description": { "type": "string", "x-aura-field-code": "description" }, "extensionDay": { "type": "integer", "format": "int32", "x-aura-field-code": "extensionDay" }, "extensionType": { "type": "integer", "format": "int32", "x-aura-field-code": "extensionType" }, "hasMaturity": { "type": "boolean", "x-aura-field-code": "hasMaturity" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductId" }, "interimContributionPayment": { "type": "integer", "format": "int32", "x-aura-field-code": "interimContributionPayment" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "isAutoRenewal": { "type": "boolean", "x-aura-field-code": "isAutoRenewal" }, "isDeposited": { "type": "boolean", "x-aura-field-code": "isDeposited" }, "isDirectMoneyOutflow": { "type": "boolean", "x-aura-field-code": "isDirectMoneyOutflow" }, "isInterimContributionPayment": { "type": "boolean", "x-aura-field-code": "isInterimContributionPayment" }, "isMaturityToFirstWorkday": { "type": "boolean", "x-aura-field-code": "isMaturityToFirstWorkday" }, "isRegularPaymentMandatory": { "type": "boolean", "x-aura-field-code": "isRegularPaymentMandatory" }, "isSpecialRateAvailable": { "type": "boolean", "x-aura-field-code": "isSpecialRateAvailable" }, "isWithdrawn": { "type": "boolean", "x-aura-field-code": "isWithdrawn" }, "maxSpecialRate": { "type": "number", "format": "decimal", "x-aura-field-code": "maxSpecialRate" }, "minSpecialRate": { "type": "number", "format": "decimal", "x-aura-field-code": "minSpecialRate" }, "minimumMaturityForPenaltyFreeWithdrawal": { "type": "integer", "format": "int32", "x-aura-field-code": "minimumMaturityForPenaltyFreeWithdrawal" }, "name": { "type": "string", "x-aura-field-code": "accountProductName" }, "parentAccountProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "parentAccountProductId" }, "regularDepositPeriodicity": { "type": "integer", "format": "int32", "x-aura-field-code": "regularDepositPeriodicity" }, "valueDay": { "type": "integer", "format": "int32", "x-aura-field-code": "valueDay" }, "valueStartDay": { "type": "integer", "format": "int32", "x-aura-field-code": "valueStartDay" } }, "required": [ "accountProductConfigs", "id", "isActive", "name" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 32, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-account-product-edit-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "account-products/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/account-products/{id}/contributions/{accountProductContributionId}/transaction-limits": { "get": { "operationId": "aurax-bff-redirect-get-account-product-transaction-limit-list", "tags": [ "account-products" ], "summary": "aurax-bff-redirect-get-account-product-transaction-limit-list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "accountProductContributionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. It returns a page of records under `data`, with `total` carrying the unpaged count — but the record's fields are not declared.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-account-product-transaction-limit-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "account-products/{id}/contributions/{accountProductContributionId}/transaction-limits", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/account-products/{id}/contributions/{accountProductContributionId}/transaction-limits/{transactionLimitId}": { "get": { "operationId": "aurax-bff-redirect-get-account-product-transaction-limit-by-id", "tags": [ "account-products" ], "summary": "aurax-bff-redirect-get-account-product-transaction-limit-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "accountProductContributionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "transactionLimitId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-account-product-transaction-limit-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "account-products/{id}/contributions/{accountProductContributionId}/transaction-limits/{transactionLimitId}", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/account-products/{id}/contributions/{contributionId}": { "get": { "operationId": "aurax-bff-redirect-get-account-product-contribution-by-id", "tags": [ "account-products" ], "summary": "aurax-bff-redirect-get-account-product-contribution-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "contributionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-account-product-contribution-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "account-products/{id}/contributions/{contributionId}", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/account-products/{id}/convertible-currencies": { "get": { "operationId": "aurax-bff-redirect-get-account-product-convertible-currency-list", "tags": [ "account-products" ], "summary": "aurax-bff-redirect-get-account-product-convertible-currency-list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. It returns a page of records under `data`, with `total` carrying the unpaged count — but the record's fields are not declared.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-account-product-convertible-currency-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "account-products/{id}/convertible-currencies", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/account-transactions": { "get": { "operationId": "aurax-bff-redirect-get-account-transaction-bpm", "tags": [ "account-transactions" ], "summary": "aurax-bff-redirect-get-account-transaction-bpm", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-account-transaction-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "account-transactions", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/accounting-entries": { "get": { "operationId": "aurax-bff-redirect-get-accounting-entry-list", "tags": [ "accounting-entries" ], "summary": "aurax-bff-redirect-get-accounting-entry-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-accounting-entry-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "accounting-entries", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": true, "collection": false }, { "name": "CorrelationId", "declared_type": null, "nullable": true, "collection": false }, { "name": "BeginDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "EndDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "UserCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "EntryType", "declared_type": null, "nullable": true, "collection": false }, { "name": "BpmFlowCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrganizationCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "GLCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "AccountingEntryDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "UserCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "EntryType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "BpmFlowCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransactionDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AccountingEntryDefinitionCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsReverse", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "OrganizationCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReferenceNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ValueDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "AccountingEntryDetails", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-accounting-entry-list", "target_dapr_app_id": "accounting-service", "target_route": "accounting-entries", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_160", "status": 400, "message": { "ar": "لم يُعثر على رمز GL '{0}'.", "en": "GL Code '{0}' is not found.", "tr": "GL Kodu '{0}' bulunamadı." }, "message_available": true, "constant_name": "GL_CODE_NOT_FOUND" }, { "code": "ERR_ACCTNG_175", "status": 400, "message": { "ar": "يجب أن يكون تاريخ الانتهاء أكبر من تاريخ البداية.", "en": "'endDate' must be bigger than 'beginDate'.", "tr": "'endDate' 'beginDate' den büyük olmalı." }, "message_available": true, "constant_name": "END_DATE_MUST_BE_BIGGER_BEGIN_DATE" } ] } }, "post": { "operationId": "aurax-bff-redirect-create-accounting-entry-bpmn-ui", "tags": [ "accounting-entries" ], "summary": "aurax-bff-redirect-create-accounting-entry-bpmn-ui", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "query", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": false, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "This usage type is outside the invocation layer's filtered set, so that layer applies no binding-source filter at all and every declared source is passed through.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-accounting-entry-bpmn-ui", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "accounting-entries", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "UserCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "EntryType", "declared_type": null, "nullable": true, "collection": false }, { "name": "BpmFlowCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountingEntryDefinitionCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ValueDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsReverse", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/accounting-entries/{id}": { "get": { "operationId": "aurax-bff-redirect-get-accounting-entry-with-detail-by-id", "tags": [ "accounting-entries" ], "summary": "aurax-bff-redirect-get-accounting-entry-with-detail-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-accounting-entry-with-detail-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "accounting-entries/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "AccountingEntryDto", "payload": "AccountingEntryDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "UserCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "EntryType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "BpmFlowCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransactionDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AccountingEntryDefinitionCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsReverse", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "OrganizationCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReferenceNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ValueDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "AccountingEntryDetails", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-accounting-entry-with-detail-by-id", "target_dapr_app_id": "accounting-service", "target_route": "accounting-entries/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_174", "status": 400, "message": { "ar": "لم يتم العثور على قيد المحاسبة بالمعرف المُعطى: «{0}»", "en": "Accounting Entry is not found with the given Id : ‘{0}’.", "tr": "Verilen Kimlikle Muhasebe Girişi bulunamadı: '{0}'." }, "message_available": true, "constant_name": "ACCOUNTING_ENTRY_NOT_FOUND" } ] } } }, "/accounting-entries/{id}/reverse": { "post": { "operationId": "aurax-bff-redirect-reverse-accounting-entry-bpmn", "tags": [ "accounting-entries" ], "summary": "aurax-bff-redirect-reverse-accounting-entry-bpmn", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-reverse-accounting-entry-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "accounting-entries/{id}/reverse", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionDate", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/accounting-entry-definitions": { "get": { "operationId": "aurax-bff-redirect-get-accounting-entry-definition-list", "tags": [ "accounting-entry-definitions" ], "summary": "aurax-bff-redirect-get-accounting-entry-definition-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-accounting-entry-definition-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "accounting-entry-definitions", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Filter", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "AccountingEntryDefinitionDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsPreviousReverseEntry", "declared_type": "bool?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-accounting-entry-definition-list", "target_dapr_app_id": "accounting-service", "target_route": "accounting-entry-definitions", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/accounting-entry-definitions/details": { "post": { "operationId": "aurax-bff-redirect-create-accounting-entry-definition-condition-detail", "tags": [ "accounting-entry-definitions" ], "summary": "aurax-bff-redirect-create-accounting-entry-definition-condition-detail", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-accounting-entry-definition-condition-detail", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "accounting-entry-definitions/details", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "put": { "operationId": "aurax-bff-redirect-update-accounting-entry-definition-and-condition-and-detail", "tags": [ "accounting-entry-definitions" ], "summary": "aurax-bff-redirect-update-accounting-entry-definition-and-condition-and-detail", "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-accounting-entry-definition-and-condition-and-detail", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "accounting-entry-definitions/details", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/accounting-entry-definitions/{id}": { "get": { "operationId": "aurax-bff-redirect-get-accounting-entry-definition-by-id", "tags": [ "accounting-entry-definitions" ], "summary": "aurax-bff-redirect-get-accounting-entry-definition-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-accounting-entry-definition-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "accounting-entry-definitions/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "AccountingEntryDefinitionDto", "payload": "AccountingEntryDefinitionDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsPreviousReverseEntry", "declared_type": "bool?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-accounting-entry-definition-by-id", "target_dapr_app_id": "accounting-service", "target_route": "accounting-entry-definitions/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_126", "status": 400, "message": { "ar": "لم يتم العثور على تعريف قيد المحاسبة باستخدام المعرف المقدم '{0}'.", "en": "Accounting Entry Definition is not found with the given Id '{0}'.", "tr": "Verilen '{0}' kimliğiyle Muhasebe Giriş Tanımı bulunamadı." }, "message_available": true, "constant_name": "ACCOUNTING_ENTRY_DEF_ID_IS_NOT_FOUND" } ] } } }, "/accounting-entry-definitions/{id}/conditions": { "get": { "operationId": "aurax-bff-redirect-get-accounting-entry-condition-by-definition-id", "tags": [ "accounting-entry-definitions" ], "summary": "aurax-bff-redirect-get-accounting-entry-condition-by-definition-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-accounting-entry-condition-by-definition-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "accounting-entry-definitions/{id}/conditions", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "AccountingEntryConditionDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "AccountingEntryDefinitionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ConditionFormula", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-accounting-entry-condition-by-definition-id", "target_dapr_app_id": "accounting-service", "target_route": "accounting-entry-definitions/{id}/conditions", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_126", "status": 400, "message": { "ar": "لم يتم العثور على تعريف قيد المحاسبة باستخدام المعرف المقدم '{0}'.", "en": "Accounting Entry Definition is not found with the given Id '{0}'.", "tr": "Verilen '{0}' kimliğiyle Muhasebe Giriş Tanımı bulunamadı." }, "message_available": true, "constant_name": "ACCOUNTING_ENTRY_DEF_ID_IS_NOT_FOUND" } ] } } }, "/accounting-entry-definitions/{id}/details": { "get": { "operationId": "aurax-bff-redirect-get-accounting-entry-definition-detail-by-definition-id", "tags": [ "accounting-entry-definitions" ], "summary": "aurax-bff-redirect-get-accounting-entry-definition-detail-by-definition-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-accounting-entry-definition-detail-by-definition-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "accounting-entry-definitions/{id}/details", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "DetailEntryDto", "collection": true, "members": [ { "name": "DetailId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AccountingEntryConditionId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AccountingEntryConditionCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FinancialTransactionCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "EntryDirection", "declared_type": "int", "nullable": false, "collection": false }, { "name": "OrdinalPosition", "declared_type": "int", "nullable": false, "collection": false }, { "name": "RefOrganizationCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RefAccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RefAmount", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RefCurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RefExchangeRate", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RefExchangeSpreadType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RefDescription", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-accounting-entry-definition-detail-by-definition-id", "target_dapr_app_id": "accounting-service", "target_route": "accounting-entry-definitions/{id}/details", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_126", "status": 400, "message": { "ar": "لم يتم العثور على تعريف قيد المحاسبة باستخدام المعرف المقدم '{0}'.", "en": "Accounting Entry Definition is not found with the given Id '{0}'.", "tr": "Verilen '{0}' kimliğiyle Muhasebe Giriş Tanımı bulunamadı." }, "message_available": true, "constant_name": "ACCOUNTING_ENTRY_DEF_ID_IS_NOT_FOUND" } ] } } }, "/accounting-transactions": { "get": { "operationId": "aurax-bff-redirect-get-accounting-transaction-list", "tags": [ "accounting-transactions" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-accounting-transaction-list", "description": "Request and response fields are declared on the routing target `get-accounting-transaction-list`; this entry declares none of its own.", "parameters": [ { "name": "accountNumber", "in": "query", "required": true, "schema": { "type": "string", "x-aura-field-code": "accountNumber" } }, { "name": "beginDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "x-aura-field-code": "balanceBeginDate" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "x-aura-field-code": "balanceEndDate" } }, { "name": "maxTransactionAmount", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "number", "format": "decimal", "x-aura-field-code": "maxTransactionAmount" } } }, { "name": "minTransactionAmount", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "number", "format": "decimal", "x-aura-field-code": "minTransactionAmount" } } }, { "name": "orderBy", "in": "query", "required": true, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": true, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 9 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "accountTransactions": { "type": "array", "items": { "type": "object", "x-aura-field-code": "accountTransactions" } }, "directionType": { "type": "string", "x-aura-field-code": "directionType" }, "explanation": { "type": "string", "x-aura-field-code": "explanation" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryId" }, "transactionAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "transactionAmount" }, "transactionDate": { "type": "string", "format": "date", "x-aura-field-code": "transactionDate" }, "transactionInfo": { "type": "object", "x-aura-field-code": "transactionInfo" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-accounting-transaction-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "accounting-transactions", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-accounting-transaction-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "BeginDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "EndDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "MinTransactionAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "MaxTransactionAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "AccountingTransactionsDto", "collection": true, "members": [ { "name": "TransactionDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "Explanation", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AccountingEntryId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "TransactionInfo", "declared_type": "TransactionInfo", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_256", "status": 400, "message": null, "message_available": false, "constant_name": "ACCOUNT_NUMBER_IS_REQUIRED" }, { "code": "ERR_ACCTNG_257", "status": 400, "message": null, "message_available": false, "constant_name": "BEGIN_DATE_IS_REQUIRED" }, { "code": "ERR_ACCTNG_258", "status": 400, "message": null, "message_available": false, "constant_name": "END_DATE_IS_REQUIRED" }, { "code": "ERR_ACCTNG_259", "status": 400, "message": null, "message_available": false, "constant_name": "END_DATE_MUST_BE_LARGER_THAN_BEGIN_DATE" }, { "code": "ERR_ACCTNG_260", "status": 400, "message": null, "message_available": false, "constant_name": "MAX_TRANSACTION_AMOUNT_MUST_BE_GREATER_THAN_MIN_TRANSACTION_AMOUNT" } ] } } }, "/accounts": { "get": { "operationId": "aurax-bff-redirect-get-account-list", "tags": [ "accounts" ], "summary": "aurax-bff-redirect-get-account-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-account-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "accounts", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "AccountDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AccountName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ProductName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OrganizationId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "AccountProductId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AccountProductType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "LedgerCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CurrencyCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Iban", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OpenedDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "ClosedDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "ClosedReason", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ClosedDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "PassbookNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsPassbookRejected", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "OrganizationParentId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "OrganizationCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OrganizationName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OrganizationAttributes", "declared_type": "Dictionary", "nullable": false, "collection": false }, { "name": "Citizenid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CitizenidType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "FullName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ProductValueStartDay", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ProductValueDay", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ProductValueDateCutOffTime", "declared_type": "TimeOnly?", "nullable": true, "collection": false }, { "name": "IsDigital", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "IsSalary", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "IsDirectMoneyOutflow", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "AccountQardHassanLimit", "declared_type": "AccountQardHassanLimitDto", "nullable": false, "collection": false }, { "name": "AccountDetails", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Constraints", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-account-list", "target_dapr_app_id": "account-service", "target_route": "accounts", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-customer-account-create-ui-bpm", "tags": [ "accounts" ], "summary": "aurax-bff-redirect-customer-account-create-ui-bpm", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-customer-account-create-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "accounts", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/accounts/by-account-number/{accountNumber}/calculate-available-balance": { "get": { "operationId": "aurax-bff-dynamic-get-calculate-available-balance-by-account-number", "tags": [ "accounts" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-calculate-available-balance-by-account-number", "description": "Request and response fields are declared on the routing target `get-calculate-available-balance-by-account-number`; this entry declares none of its own.", "parameters": [ { "name": "accountNumber", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "accountNumber" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "accountId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountId" }, "accountNumber": { "type": "string", "x-aura-field-code": "accountNumber" }, "availableBalance": { "type": "number", "format": "decimal", "x-aura-field-code": "calculate" }, "balance": { "type": "number", "format": "decimal", "x-aura-field-code": "balance" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-calculate-available-balance-by-account-number", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "accounts/by-account-number/{accountNumber}/calculate-available-balance", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "AvailableBalanceDto", "payload": "AvailableBalanceDto", "collection": false, "members": [ { "name": "AccountId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AvailableBalance", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "Balance", "declared_type": "decimal?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-calculate-available-balance-by-account-number", "target_dapr_app_id": "account-service", "target_route": "accounts/by-account-number/{accountNumber}/calculate-available-balance", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCNT_16", "status": 400, "message": { "ar": "لم يتم العثور على الحساب.", "en": "Account not found.", "tr": "Hesap bulunamadı." }, "message_available": true, "constant_name": "ACCOUNT_MUST_BE_NOT_NULL" } ] } } }, "/accounts/by-customer-id/{customerId}": { "get": { "operationId": "aurax-bff-redirect-get-account-by-customer-id", "tags": [ "accounts" ], "summary": "aurax-bff-redirect-get-account-by-customer-id", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-account-by-customer-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "accounts/by-customer-id/{customerId}", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "AccountDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AccountName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ProductName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OrganizationId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "AccountProductId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AccountProductType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "LedgerCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CurrencyCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Iban", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OpenedDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "ClosedDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "ClosedReason", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ClosedDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "PassbookNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsPassbookRejected", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "OrganizationParentId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "OrganizationCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OrganizationName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OrganizationAttributes", "declared_type": "Dictionary", "nullable": false, "collection": false }, { "name": "Citizenid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CitizenidType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "FullName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ProductValueStartDay", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ProductValueDay", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ProductValueDateCutOffTime", "declared_type": "TimeOnly?", "nullable": true, "collection": false }, { "name": "IsDigital", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "IsSalary", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "IsDirectMoneyOutflow", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "AccountQardHassanLimit", "declared_type": "AccountQardHassanLimitDto", "nullable": false, "collection": false }, { "name": "AccountDetails", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Constraints", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-account-by-customer-id", "target_dapr_app_id": "account-service", "target_route": "accounts/by-customer-id/{customerId}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCNT_16", "status": 400, "message": { "ar": "لم يتم العثور على الحساب.", "en": "Account not found.", "tr": "Hesap bulunamadı." }, "message_available": true, "constant_name": "ACCOUNT_MUST_BE_NOT_NULL" } ] } } }, "/accounts/by-customer-id/{customerId}/by-product-type/{accountProductType}": { "get": { "operationId": "aurax-bff-redirect-get-account-by-customer-id-and-product-type", "tags": [ "accounts" ], "summary": "aurax-bff-redirect-get-account-by-customer-id-and-product-type", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "accountProductType", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-account-by-customer-id-and-product-type", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "accounts/by-customer-id/{customerId}/by-product-type/{accountProductType}", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "AccountDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AccountName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ProductName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OrganizationId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "AccountProductId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AccountProductType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "LedgerCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CurrencyCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Iban", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OpenedDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "ClosedDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "ClosedReason", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ClosedDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "PassbookNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsPassbookRejected", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "OrganizationParentId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "OrganizationCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OrganizationName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OrganizationAttributes", "declared_type": "Dictionary", "nullable": false, "collection": false }, { "name": "Citizenid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CitizenidType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "FullName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ProductValueStartDay", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ProductValueDay", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ProductValueDateCutOffTime", "declared_type": "TimeOnly?", "nullable": true, "collection": false }, { "name": "IsDigital", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "IsSalary", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "IsDirectMoneyOutflow", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "AccountQardHassanLimit", "declared_type": "AccountQardHassanLimitDto", "nullable": false, "collection": false }, { "name": "AccountDetails", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Constraints", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-account-by-customer-id-and-product-type", "target_dapr_app_id": "account-service", "target_route": "accounts/by-customer-id/{customerId}/by-product-type/{accountProductType}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCNT_16", "status": 400, "message": { "ar": "لم يتم العثور على الحساب.", "en": "Account not found.", "tr": "Hesap bulunamadı." }, "message_available": true, "constant_name": "ACCOUNT_MUST_BE_NOT_NULL" } ] } } }, "/accounts/{accountId}": { "get": { "operationId": "aurax-bff-redirect-get-account-by-id", "tags": [ "accounts" ], "summary": "aurax-bff-redirect-get-account-by-id", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only", "x-aura-catalog-parameter-name": "id" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-account-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "accounts/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "AccountDto", "payload": "AccountDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AccountName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ProductName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OrganizationId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "AccountProductId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AccountProductType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "LedgerCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CurrencyCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Iban", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OpenedDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "ClosedDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "ClosedReason", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ClosedDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "PassbookNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsPassbookRejected", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "OrganizationParentId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "OrganizationCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OrganizationName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OrganizationAttributes", "declared_type": "Dictionary", "nullable": false, "collection": false }, { "name": "Citizenid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CitizenidType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "FullName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "IsDigital", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "AccountQardHassanLimit", "declared_type": "AccountQardHassanLimitDto", "nullable": false, "collection": false }, { "name": "AccountDetails", "declared_type": "List", "nullable": false, "collection": true }, { "name": "ConsentItemIds", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCNT_16", "status": 400, "message": null, "message_available": false, "constant_name": "ACCOUNT_MUST_BE_NOT_NULL" } ] }, "x-aura-path-template-merged": { "catalog_template": "/accounts/{id}", "published_template": "/accounts/{accountId}", "renamed": { "id": "accountId" }, "reason": "OpenAPI 3.1 §4.8.8 — paths differing only in template variable names are identical and MUST NOT coexist. A path parameter name is local to the template and positional on the wire, so this rename does not change the request; the catalog names are preserved on each parameter and here." } }, "put": { "operationId": "aurax-bff-redirect-customer-account-edit-ui-bpm", "tags": [ "accounts" ], "summary": "aurax-bff-redirect-customer-account-edit-ui-bpm", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-customer-account-edit-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "accounts/{accountId}", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/accrual-calculation/{accrualTransactionId}": { "get": { "operationId": "aurax-bff-redirect-get-accrual-calculation-by-transaction-id", "tags": [ "accrual-calculation" ], "summary": "aurax-bff-redirect-get-accrual-calculation-by-transaction-id", "parameters": [ { "name": "accrualTransactionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-accrual-calculation-by-transaction-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "accrual-calculation/{accrualTransactionId}", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "AccrualCalculationByTransactionIdDto", "payload": "AccrualCalculationByTransactionIdDto", "collection": false, "members": [ { "name": "AccrualProductType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "AccrualType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "AccountingEntryProcessType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "LastDayAccountingType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "CashFlows", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-accrual-calculation-by-transaction-id", "target_dapr_app_id": "accrual-service", "target_route": "calculations/by-transaction-id/{accrualTransactionId}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/accrual-products": { "get": { "operationId": "aurax-bff-redirect-get-accrual-product-list", "tags": [ "accrual-products" ], "summary": "aurax-bff-redirect-get-accrual-product-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-accrual-product-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "accrual-products", "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "AccrualProductAndFieldsDto", "collection": true, "members": [ { "name": "AccrualProductFields", "declared_type": "List", "nullable": false, "collection": true }, { "name": "AccrualProductFormulas", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-accrual-product-list", "target_dapr_app_id": "accrual-service", "target_route": "products", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-accrual-product-bpmn", "tags": [ "accrual-products" ], "summary": "aurax-bff-redirect-create-accrual-product-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-accrual-product-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "accrual-products", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "put": { "operationId": "aurax-bff-redirect-update-accrual-product-and-product-fields-and-formulas-bpmn", "tags": [ "accrual-products" ], "summary": "aurax-bff-redirect-update-accrual-product-and-product-fields-and-formulas-bpmn", "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-accrual-product-and-product-fields-and-formulas-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "accrual-products", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/accrual-products/{id}": { "get": { "operationId": "aurax-bff-redirect-get-accrual-product-by-id", "tags": [ "accrual-products" ], "summary": "aurax-bff-redirect-get-accrual-product-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-accrual-product-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "accrual-products/{id}", "x-aura-code-response": { "state": "structure", "declared_type": "AccrualProductAndFieldsDto", "payload": "AccrualProductAndFieldsDto", "collection": false, "members": [ { "name": "AccrualProductFields", "declared_type": "List", "nullable": false, "collection": true }, { "name": "AccrualProductFormulas", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-accrual-product-by-id", "target_dapr_app_id": "accrual-service", "target_route": "products/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCRL_2", "status": 400, "message": { "ar": "لم يتم العثور على المنتج بالمعرّف المقدم: '{0}'.", "en": "Product is cannot be found with the given: {0}.", "tr": "Verilen ürün bulunamadı: {0}." }, "message_available": true, "constant_name": "PRODUCT_IS_NOT_FOUND" } ] } } }, "/accrual-transactions": { "get": { "operationId": "aurax-bff-redirect-get-accrual-transaction-list", "tags": [ "accrual-transactions" ], "summary": "aurax-bff-redirect-get-accrual-transaction-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-accrual-transaction-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "accrual-transactions", "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "AccrualTransactionDto", "collection": true, "members": [ { "name": "AccrualType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "AccrualProductId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ProductTransactionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "TransactionOrganizationCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransactionDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "MaturityBeginDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "MaturityEndDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "YearlyProfitRate", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "TransactionProductLedgerCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerAccountId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Xirr", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "EffectiveProfitRate", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "EarlyPaymentDiscountRate", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "CashFlows", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-accrual-transaction-list", "target_dapr_app_id": "accrual-service", "target_route": "transactions", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/action-groups": { "get": { "operationId": "aurax-bff-redirect-aurax-management-get-action-group-list", "tags": [ "action-groups" ], "summary": "aurax-bff-redirect-aurax-management-get-action-group-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-aurax-management-get-action-group-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "action-groups", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "ActionGroupDto", "collection": true, "members": [ { "name": "Name", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "aurax-management-get-action-group-list", "target_dapr_app_id": "aurax-management-service", "target_route": "action-groups", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-aurax-management-create-action-group", "tags": [ "action-groups" ], "summary": "aurax-bff-redirect-aurax-management-create-action-group", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-aurax-management-create-action-group", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "action-groups", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/action-groups/{id}": { "delete": { "operationId": "aurax-bff-redirect-aurax-management-delete-action-group", "tags": [ "action-groups" ], "summary": "aurax-bff-redirect-aurax-management-delete-action-group", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-aurax-management-delete-action-group", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "action-groups/{id}", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "get": { "operationId": "aurax-bff-redirect-aurax-management-get-action-group-by-id", "tags": [ "action-groups" ], "summary": "aurax-bff-redirect-aurax-management-get-action-group-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-aurax-management-get-action-group-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "action-groups/{id}", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "ActionGroupDto", "payload": "ActionGroupDto", "collection": false, "members": [ { "name": "Name", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "aurax-management-get-action-group-by-id", "target_dapr_app_id": "aurax-management-service", "target_route": "action-groups/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_FRMCTL_14", "status": 400, "message": null, "message_available": false, "constant_name": "ACTION_GROUP_ID_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-aurax-management-update-action-group", "tags": [ "action-groups" ], "summary": "aurax-bff-redirect-aurax-management-update-action-group", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-aurax-management-update-action-group", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "action-groups/{id}", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/actions": { "get": { "operationId": "aurax-bff-redirect-aurax-management-get-action-definition-list", "tags": [ "actions" ], "summary": "aurax-bff-redirect-aurax-management-get-action-definition-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-aurax-management-get-action-definition-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "actions", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "ActionDefinitionDto", "collection": true, "members": [ { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IconName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SortOrder", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "UsageType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ActionType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ActionProps", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Translations", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "aurax-management-get-action-definition-list", "target_dapr_app_id": "aurax-management-service", "target_route": "actions", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-aurax-management-create-action-definition", "tags": [ "actions" ], "summary": "aurax-bff-redirect-aurax-management-create-action-definition", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-aurax-management-create-action-definition", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "actions", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/actions/{id}": { "delete": { "operationId": "aurax-bff-redirect-aurax-management-delete-action-definition", "tags": [ "actions" ], "summary": "aurax-bff-redirect-aurax-management-delete-action-definition", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-aurax-management-delete-action-definition", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "actions/{id}", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "get": { "operationId": "aurax-bff-redirect-aurax-management-get-action-definition-by-id", "tags": [ "actions" ], "summary": "aurax-bff-redirect-aurax-management-get-action-definition-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-aurax-management-get-action-definition-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "actions/{id}", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "ActionDefinitionDto", "payload": "ActionDefinitionDto", "collection": false, "members": [ { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IconName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SortOrder", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "UsageType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ActionType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ActionProps", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Translations", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "aurax-management-get-action-definition-by-id", "target_dapr_app_id": "aurax-management-service", "target_route": "actions/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_FRMCTL_12", "status": 400, "message": null, "message_available": false, "constant_name": "ACTION_DEFINITION_ID_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-aurax-management-update-action-definition", "tags": [ "actions" ], "summary": "aurax-bff-redirect-aurax-management-update-action-definition", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-aurax-management-update-action-definition", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "actions/{id}", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/address-types": { "get": { "operationId": "aurax-bff-dynamic-get-address-type-list", "tags": [ "address-types" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-address-type-list", "description": "Request and response fields are declared on the routing target `get-address-type-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "addressTypeFields": { "type": "array", "items": { "type": "object", "properties": { "fieldKey": { "type": "string", "x-aura-field-code": "addressTypeFieldKey" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "addressTypeFieldId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "isMandatory": { "type": "boolean", "x-aura-field-code": "isMandatory" }, "separatorMark": { "type": "string", "x-aura-field-code": "separatorMark" }, "sequenceNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "sequenceNumber" }, "translations": { "type": "array", "items": { "type": "object", "properties": { "languageCode": { "type": "string", "x-aura-field-code": "languageCode" }, "name": { "type": "string", "x-aura-field-code": "translations_name" } }, "x-aura-field-code": "translations" } }, "typeId": { "type": "string", "format": "uuid", "x-aura-field-code": "addressTypeId" } }, "x-aura-field-code": "addressTypeFields" } }, "code": { "type": "string", "x-aura-field-code": "addressTypeCode" }, "country": { "type": "integer", "format": "int32", "x-aura-field-code": "country" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "addressTypeId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "name": { "type": "string", "x-aura-field-code": "addressTypeName" }, "translations": { "type": "array", "items": { "type": "object", "properties": { "languageCode": { "type": "string", "x-aura-field-code": "languageCode" }, "name": { "type": "string", "x-aura-field-code": "translations_name" } }, "x-aura-field-code": "translations" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-address-type-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "address-types", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-address-type-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "post": { "operationId": "aurax-bff-dynamic-create-address-template-bpm", "tags": [ "address-types" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "create-address-template-bpm", "description": "Invokes the `aurax-bff-dynamic-create-address-template-bpm` service definition through `POST /address-types`.\n\nRequest and response fields are declared on the routing target `create-address-template-bpm`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "addressTypeFields": { "type": "array", "items": { "type": "object", "properties": { "fieldKey": { "type": "string", "x-aura-field-code": "addressTypeFieldKey" }, "isMandatory": { "type": "boolean", "x-aura-field-code": "isMandatory" }, "isVisible": { "type": "boolean", "x-aura-field-code": "isVisible" }, "separatorMark": { "type": "string", "x-aura-field-code": "separatorMark" }, "sequenceNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "sequence" } }, "x-aura-field-code": "addressTypeFields" } }, "code": { "type": "string", "x-aura-field-code": "addressTypeCode" }, "country": { "type": "integer", "format": "int32", "x-aura-field-code": "country" }, "name": { "type": "string", "x-aura-field-code": "addressTypeName" } }, "required": [ "code", "name" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 4, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-create-address-template-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "address-types", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/address-types/{id}": { "delete": { "operationId": "aurax-bff-dynamic-delete-address-type-definition", "tags": [ "address-types" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "delete-address-type-definition", "description": "Invokes the `aurax-bff-dynamic-delete-address-type-definition` service definition through `DELETE /address-types/{id}`.\n\nRequest and response fields are declared on the routing target `delete-address-type-definition`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "addressTypeId" } } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-delete-address-type-definition", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "address-types/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "get": { "operationId": "aurax-bff-dynamic-get-address-type-by-id", "tags": [ "address-types" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-address-type-by-id", "description": "Request and response fields are declared on the routing target `get-address-type-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "addressTypeId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "addressTypeFields": { "type": "array", "items": { "type": "object", "properties": { "fieldKey": { "type": "string", "x-aura-field-code": "addressTypeFieldKey" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "addressTypeFieldId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "isMandatory": { "type": "boolean", "x-aura-field-code": "isMandatory" }, "isVisible": { "type": "boolean", "x-aura-field-code": "isVisible" }, "separatorMark": { "type": "string", "x-aura-field-code": "separatorMark" }, "sequenceNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "sequenceNumber" }, "translations": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "x-aura-field-code": "translations_name" } }, "x-aura-field-code": "translations" } }, "typeId": { "type": "string", "format": "uuid", "x-aura-field-code": "addressTypeId" } }, "x-aura-field-code": "addressTypeFields" } }, "code": { "type": "string", "x-aura-field-code": "addressTypeCode" }, "country": { "type": "integer", "format": "int32", "x-aura-field-code": "country" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "addressTypeId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "name": { "type": "string", "x-aura-field-code": "addressTypeName" }, "translations": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "x-aura-field-code": "translations_name" } }, "x-aura-field-code": "translations" } } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-address-type-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "address-types/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "put": { "operationId": "aurax-bff-dynamic-update-address-template-bpm", "tags": [ "address-types" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "update-address-template-bpm", "description": "Invokes the `aurax-bff-dynamic-update-address-template-bpm` service definition through `PUT /address-types/{id}`.\n\nRequest and response fields are declared on the routing target `update-address-template-bpm`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in this route template but not among the Route-bound fields of the routing target `update-address-template-bpm`, whose own path is decoupled from this one.", "x-aura-source": "route-template-only-after-collapse" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "addressTypeFields": { "type": "array", "items": { "type": "object", "properties": { "fieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "addressTypeFieldId" }, "fieldKey": { "type": "string", "x-aura-field-code": "addressTypeFieldKey" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "isMandatory": { "type": "boolean", "x-aura-field-code": "isMandatory" }, "isVisible": { "type": "boolean", "x-aura-field-code": "isVisible" }, "rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "separatorMark": { "type": "string", "x-aura-field-code": "separatorMark" }, "sequenceNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "sequence" }, "typeId": { "type": "string", "format": "uuid", "x-aura-field-code": "addressTypeId" } }, "x-aura-field-code": "addressTypeFields" } }, "code": { "type": "string", "x-aura-field-code": "addressTypeCode" }, "country": { "type": "integer", "format": "int32", "x-aura-field-code": "country" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "addressTypeId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "name": { "type": "string", "x-aura-field-code": "addressTypeName" } }, "required": [ "code", "id", "isActive", "name" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 6, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-update-address-template-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "address-types/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/address/buildings/by-street-code/{streetCode}": { "get": { "operationId": "aurax-bff-redirect-get-building-list", "tags": [ "address" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-building-list", "description": "Request and response fields are declared on the routing target `get-building-list`; this entry declares none of its own.", "parameters": [ { "name": "streetCode", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "streetCode" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "externalServiceResult": { "type": "array", "items": { "type": "object", "properties": { "buildingNumber": { "x-aura-type": "unresolved" }, "extDoorNumber": { "x-aura-type": "unresolved" }, "islandNumber": { "x-aura-type": "unresolved" }, "streetCode": { "type": "integer", "format": "int32", "x-aura-field-code": "streetCode" } }, "x-aura-field-code": "externalServiceResults" } }, "externalServiceResultId": { "type": "string", "format": "uuid", "x-aura-field-code": "externalServiceResultId" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-building-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "address/buildings/by-street-code/{streetCode}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-building-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "StreetCode", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ExternalServiceResultDto>", "envelopes": [ "ExternalServiceResultDto", "IEnumerable" ], "payload": "BuildingDto", "collection": true, "members": [ { "name": "IslandNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BuildingNumber", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ExtDoorNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "StreetCode", "declared_type": "int?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-building-list", "target_dapr_app_id": "integration-service", "target_route": "address/buildings/by-street-code/{streetCode}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/address/cities": { "get": { "operationId": "aurax-bff-redirect-get-city-list", "tags": [ "address" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-city-list", "description": "Request and response fields are declared on the routing target `get-city-list`; this entry declares none of its own.", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "externalServiceResult": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "x-aura-field-code": "cityCode" }, "name": { "type": "string", "x-aura-field-code": "cityName" } }, "x-aura-field-code": "externalServiceResults" } }, "externalServiceResultId": { "type": "string", "format": "uuid", "x-aura-field-code": "externalServiceResultId" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-city-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "address/cities", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "no-members" }, "x-aura-code-response": { "state": "structure", "declared_type": "ExternalServiceResultDto>", "envelopes": [ "ExternalServiceResultDto", "IEnumerable" ], "payload": "CityDto", "collection": true, "members": [ { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "int?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/address/districts/by-city-code/{cityCode}": { "get": { "operationId": "aurax-bff-redirect-get-district-list-by-city-code", "tags": [ "address" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-district-list-by-city-code", "description": "Request and response fields are declared on the routing target `get-district-list-by-city-code`; this entry declares none of its own.", "parameters": [ { "name": "cityCode", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "cityCode" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "externalServiceResult": { "type": "array", "items": { "type": "object", "properties": { "cityCode": { "type": "integer", "format": "int32", "x-aura-field-code": "cityCode" }, "code": { "type": "integer", "format": "int32", "x-aura-field-code": "districtCode" }, "name": { "type": "string", "x-aura-field-code": "cityName" } }, "x-aura-field-code": "externalServiceResults" } }, "externalServiceResultId": { "type": "string", "format": "uuid", "x-aura-field-code": "externalServiceResultId" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-district-list-by-city-code", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "address/districts/by-city-code/{cityCode}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CityCode", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ExternalServiceResultDto>", "envelopes": [ "ExternalServiceResultDto", "IEnumerable" ], "payload": "DistrictDto", "collection": true, "members": [ { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "int", "nullable": false, "collection": false }, { "name": "CityCode", "declared_type": "int", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/address/neighbourhoods/by-district-code/{districtCode}": { "get": { "operationId": "aurax-bff-redirect-get-neighbourhood-list-by-district-code", "tags": [ "address" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-neighbourhood-list-by-district-code", "description": "Request and response fields are declared on the routing target `get-neighbourhood-list-by-district-code`; this entry declares none of its own.", "parameters": [ { "name": "districtCode", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "districtCode" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "externalServiceResult": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "x-aura-field-code": "cityCode" }, "districtCode": { "type": "integer", "format": "int32", "x-aura-field-code": "districtCode" }, "name": { "type": "string", "x-aura-field-code": "cityName" } }, "x-aura-field-code": "externalServiceResults" } }, "externalServiceResultId": { "type": "string", "format": "uuid", "x-aura-field-code": "externalServiceResultId" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-neighbourhood-list-by-district-code", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "address/neighbourhoods/by-district-code/{districtCode}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "DistrictCode", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ExternalServiceResultDto>", "envelopes": [ "ExternalServiceResultDto", "IEnumerable" ], "payload": "NeighbourhoodDto", "collection": true, "members": [ { "name": "Code", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DistrictCode", "declared_type": "int?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-neighbourhood-list-by-district-code", "target_dapr_app_id": "integration-service", "target_route": "address/neighbourhoods/by-district-code/{districtCode}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/address/sections/by-building-code/{buildingCode}": { "get": { "operationId": "aurax-bff-redirect-get-section-list", "tags": [ "address" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-section-list", "description": "Request and response fields are declared on the routing target `get-section-list`; this entry declares none of its own.", "parameters": [ { "name": "buildingCode", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "buildingCode" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "externalServiceResult": { "type": "array", "items": { "type": "object", "properties": { "buildingCode": { "type": "integer", "format": "int32", "x-aura-field-code": "buildingCode" }, "floorNumber": { "type": "string", "x-aura-field-code": "floorNumber" }, "intDoorNumber": { "type": "string", "x-aura-field-code": "intDoorNumber" } }, "x-aura-field-code": "externalServiceResults" } }, "externalServiceResultId": { "type": "string", "format": "uuid", "x-aura-field-code": "externalServiceResultId" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-section-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "address/sections/by-building-code/{buildingCode}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-section-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "BuildingCode", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ExternalServiceResultDto>", "envelopes": [ "ExternalServiceResultDto", "IEnumerable" ], "payload": "SectionDto", "collection": true, "members": [ { "name": "FloorNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IntDoorNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BuildingCode", "declared_type": "int?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-section-list", "target_dapr_app_id": "integration-service", "target_route": "address/sections/by-building-code/{buildingCode}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/address/streets/by-neighbourhood-code/{neighbourhoodCode}": { "get": { "operationId": "aurax-bff-redirect-get-street-list-by-neighbourhood-code", "tags": [ "address" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-street-list-by-neighbourhood-code", "description": "Request and response fields are declared on the routing target `get-street-list-by-neighbourhood-code`; this entry declares none of its own.", "parameters": [ { "name": "neighbourhoodCode", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "neighbourhoodCode" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "externalServiceResult": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "x-aura-field-code": "cityCode" }, "name": { "type": "string", "x-aura-field-code": "cityName" }, "neighbourhoodCode": { "type": "integer", "format": "int32", "x-aura-field-code": "neighbourhoodCode" } }, "x-aura-field-code": "externalServiceResults" } }, "externalServiceResultId": { "type": "string", "format": "uuid", "x-aura-field-code": "externalServiceResultId" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-street-list-by-neighbourhood-code", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "address/streets/by-neighbourhood-code/{neighbourhoodCode}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "NeighbourhoodCode", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ExternalServiceResultDto>", "envelopes": [ "ExternalServiceResultDto", "IEnumerable" ], "payload": "StreetDto", "collection": true, "members": [ { "name": "Code", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "NeighbourhoodCode", "declared_type": "int?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-street-list-by-neighbourhood-code", "target_dapr_app_id": "integration-service", "target_route": "address/streets/by-neighbourhood-code/{neighbourhoodCode}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/admin/users/{userId}/logout": { "post": { "operationId": "aurax-bff-redirect-dynamic-logout", "tags": [ "admin" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "Logout", "description": "Invokes the `aurax-bff-redirect-dynamic-logout` service definition through `POST /admin/users/{userId}/logout`.\n\nRequest and response fields are declared on the routing target `logout`; this entry declares none of its own.\n\nDeclared as Route-bound but absent from the route template, so not sendable: realm.", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "userId" } } ], "x-aura-request-binding": { "method": "POST", "admits": [ "route", "query", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": false, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 2, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "This usage type is outside the invocation layer's filtered set, so that layer applies no binding-source filter at all and every declared source is passed through.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-dynamic-logout", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "admin/users/{userId}/logout", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/allotment-assignments": { "post": { "operationId": "aurax-bff-redirect-create-allotment-assignment-bpmn", "tags": [ "allotment-assignments" ], "summary": "aurax-bff-redirect-create-allotment-assignment-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-allotment-assignment-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "allotment-assignments", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/allotment-assignments/{id}": { "get": { "operationId": "aurax-bff-redirect-get-allotment-assignment-by-id", "tags": [ "allotment-assignments" ], "summary": "aurax-bff-redirect-get-allotment-assignment-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-allotment-assignment-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "allotment-assignments/{id}", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "AllotmentAssignmentDto", "payload": "AllotmentAssignmentDto", "collection": false, "members": [ { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "FinancialAnalysisId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "AllotmentDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "ValidityEndDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "AllotmentAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "ExternalCalculatedLimit", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "InternalCalculatedLimit", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AllotmentStatus", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Collaterals", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Comments", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Details", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Products", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-allotment-assignment-by-id", "target_dapr_app_id": "allotment-service", "target_route": "assignments/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ALLTMNT_11", "status": 400, "message": { "ar": "لا يمكن العثور على تخصيص الحصة باستخدام: {0}.", "en": "Allotment assignment is cannot be found with the given: {0}.", "tr": "Tahsis ataması bulunamadı: {0}." }, "message_available": true, "constant_name": "ALLOTMENT_ASSIGNMENT_MUST_BE_EXIST" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-allotment-assignment-and-details-bpmn", "tags": [ "allotment-assignments" ], "summary": "aurax-bff-redirect-update-allotment-assignment-and-details-bpmn", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-allotment-assignment-and-details-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "allotment-assignments/{id}", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/allotment-products": { "get": { "operationId": "aurax-bff-redirect-get-allotment-product-list", "tags": [ "allotment-products" ], "summary": "aurax-bff-redirect-get-allotment-product-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-allotment-product-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "allotment-products", "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "AllotmentProductParentDto", "collection": true, "members": [ { "name": "ParentAllotmentProductName", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-allotment-product-list", "target_dapr_app_id": "allotment-service", "target_route": "products", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-allotment-product-bpmn", "tags": [ "allotment-products" ], "summary": "aurax-bff-redirect-create-allotment-product-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-allotment-product-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "allotment-products", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "put": { "operationId": "aurax-bff-redirect-update-allotment-product-and-fields-bpmn", "tags": [ "allotment-products" ], "summary": "aurax-bff-redirect-update-allotment-product-and-fields-bpmn", "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-allotment-product-and-fields-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "allotment-products", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/allotment-products/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-allotment-product-bpmn", "tags": [ "allotment-products" ], "summary": "aurax-bff-redirect-delete-allotment-product-bpmn", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-allotment-product-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "allotment-products/{id}", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "get": { "operationId": "aurax-bff-redirect-get-allotment-product-by-id", "tags": [ "allotment-products" ], "summary": "aurax-bff-redirect-get-allotment-product-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-allotment-product-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "allotment-products/{id}", "x-aura-code-response": { "state": "structure", "declared_type": "AllotmentProductDto", "payload": "AllotmentProductDto", "collection": false, "members": [ { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsLastLeaf", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "ParentAllotmentProductId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "AccountProductId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "AllotmentType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "MinAllotmentValidityDay", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "MaxAllotmentValidityDay", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "DefaultAllotmentValidityDay", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "AllotmentProductFields", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-allotment-product-by-id", "target_dapr_app_id": "allotment-service", "target_route": "products/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ALLTMNT_3", "status": 400, "message": { "ar": "لا يمكن العثور على المنتج باستخدام البيانات المقدمة: {0}.", "en": "Product is cannot be found with the given: {0}.", "tr": "ürün bulunamadı: {0}." }, "message_available": true, "constant_name": "PRODUCT_MUST_BE_EXIST" } ] } } }, "/allotment-products/{id}/fields": { "get": { "operationId": "aurax-bff-redirect-get-allotment-product-field-by-id", "tags": [ "allotment-products" ], "summary": "aurax-bff-redirect-get-allotment-product-field-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-allotment-product-field-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "allotment-products/{id}/fields", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "AllotmentProductFieldDto", "collection": true, "members": [ { "name": "AllotmentProductFieldId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DataType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "IsMandatory", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-allotment-product-field-by-id", "target_dapr_app_id": "allotment-service", "target_route": "products/{id}/fields", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ALLTMNT_3", "status": 400, "message": { "ar": "لا يمكن العثور على المنتج باستخدام البيانات المقدمة: {0}.", "en": "Product is cannot be found with the given: {0}.", "tr": "ürün bulunamadı: {0}." }, "message_available": true, "constant_name": "PRODUCT_MUST_BE_EXIST" } ] } } }, "/allotment-queries": { "get": { "operationId": "aurax-bff-redirect-get-allotment-query-list", "tags": [ "allotment-queries" ], "summary": "aurax-bff-redirect-get-allotment-query-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-allotment-query-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "allotment-queries", "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "AllotmentQueryDto", "collection": true, "members": [ { "name": "CustomerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "QueryDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "AllotmentAssignmentId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AllotmentAssignmentProductId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AllotmentProductId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AllotmentAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ProductAllotmentAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CustomerRiskId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "AvailableAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "ProductCollaterals", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-allotment-query-list", "target_dapr_app_id": "allotment-service", "target_route": "queries", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/allotment-queries/{id}": { "get": { "operationId": "aurax-bff-redirect-get-allotment-query-by-id", "tags": [ "allotment-queries" ], "summary": "aurax-bff-redirect-get-allotment-query-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-allotment-query-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "allotment-queries/{id}", "x-aura-code-response": { "state": "structure", "declared_type": "AllotmentQueryDto", "payload": "AllotmentQueryDto", "collection": false, "members": [ { "name": "CustomerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "QueryDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "AllotmentAssignmentId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AllotmentAssignmentProductId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AllotmentProductId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AllotmentAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ProductAllotmentAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CustomerRiskId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "AvailableAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "ProductCollaterals", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-allotment-query-by-id", "target_dapr_app_id": "allotment-service", "target_route": "queries/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ALLTMNT_29", "status": 400, "message": { "ar": "لا يمكن العثور على استعلام التخصيص باستخدام: {0}.", "en": "Allotment query is cannot be found with the given:{0}.", "tr": "Tahsis sorgusu bulunamadı: {0}." }, "message_available": true, "constant_name": "ALLOTMENT_QUERY_IS_NOT_FOUND_WITH_THE_GIVEN_ID" } ] } } }, "/aml-item-configs": { "get": { "operationId": "aurax-bff-redirect-get-aml-item-config-list", "tags": [ "aml-item-configs" ], "summary": "aurax-bff-redirect-get-aml-item-config-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-aml-item-config-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "aml-item-configs", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "AmlItemConfigDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "SearchType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ItemCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ItemValue", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-aml-item-config-list", "target_dapr_app_id": "integration-service", "target_route": "aml-item-configs", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-aml-item-config-ui-bpm", "tags": [ "aml-item-configs" ], "summary": "aurax-bff-redirect-create-aml-item-config-ui-bpm", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-aml-item-config-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "aml-item-configs", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "SearchType", "declared_type": null, "nullable": true, "collection": false }, { "name": "ItemCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ItemValue", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/aml-item-configs/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-aml-item-config-ui-bpm", "tags": [ "aml-item-configs" ], "summary": "aurax-bff-redirect-delete-aml-item-config-ui-bpm", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-aml-item-config-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "aml-item-configs/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "get": { "operationId": "aurax-bff-redirect-get-aml-item-config-by-id", "tags": [ "aml-item-configs" ], "summary": "aurax-bff-redirect-get-aml-item-config-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-aml-item-config-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "aml-item-configs/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "AmlItemConfigDto", "payload": "AmlItemConfigDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "SearchType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ItemCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ItemValue", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-aml-item-config-by-id", "target_dapr_app_id": "integration-service", "target_route": "aml-item-configs/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_INTGRTN_38", "status": 400, "message": { "ar": "لا يمكن العثور على إعداد عنصر مكافحة غسيل الأموال.", "en": "AML Item Config cannot be found.", "tr": "AML Öğesi Yapılandırması bulunamadı." }, "message_available": true, "constant_name": "AML_ITEM_CONFIG_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-aml-item-config-ui-bpm", "tags": [ "aml-item-configs" ], "summary": "aurax-bff-redirect-update-aml-item-config-ui-bpm", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-aml-item-config-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "aml-item-configs/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "ItemValue", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/api/account-products/contributions": { "get": { "operationId": "aurax-bff-redirect-get-account-product-contribution-list", "tags": [ "account-products" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-account-product-contribution-list", "description": "Request and response fields are declared on the routing target `get-account-product-contribution-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "accountProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductId" }, "accountProductTaxes": { "type": "array", "items": { "type": "object", "properties": { "accountProductContributionId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductContributionId" }, "accountProductTaxesId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductTaxesId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductTaxId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "taxId": { "type": "string", "format": "uuid", "x-aura-field-code": "taxId" } }, "x-aura-field-code": "accountProductTaxes" } }, "beginDate": { "type": "string", "format": "date-time", "x-aura-field-code": "beginDate" }, "contributionRate": { "type": "number", "format": "decimal", "x-aura-field-code": "contributionRate" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "contributionId" }, "maturityUnit": { "type": "integer", "format": "int32", "x-aura-field-code": "maturityUnit" }, "maxAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "maxAmount" }, "maxBalance": { "type": "number", "format": "decimal", "x-aura-field-code": "maxBalance" }, "maxMaturity": { "type": "integer", "format": "int32", "x-aura-field-code": "maxMaturity" }, "minAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "minAmount" }, "minBalance": { "type": "number", "format": "decimal", "x-aura-field-code": "minBalance" }, "minMaturity": { "type": "integer", "format": "int32", "x-aura-field-code": "minMaturity" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-account-product-contribution-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/account-products/contributions", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-account-product-contribution-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "AccountProductContributionDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AccountProductId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CurrencyCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MinAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "MaxAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "MinMaturity", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "MaxMaturity", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "MaturityUnit", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ContributionRate", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "MinBalance", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "MaxBalance", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "BeginDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "EndDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "PoolDefinitionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "PoolDefinitionRateId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "AccountProductTaxes", "declared_type": "List", "nullable": false, "collection": true }, { "name": "AccountProductTransactionLimits", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." } } }, "/api/accounting-entry-data-list": { "get": { "operationId": "aurax-bff-redirect-get-accounting-entry-list-for-e-ledger", "tags": [ "accounting-entry-data-list" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-accounting-entry-list-for-e-ledger", "description": "Request and response fields are declared on the routing target `get-accounting-entry-list-for-eLedger`; this entry declares none of its own.", "parameters": [ { "name": "beginDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "x-aura-field-code": "date" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "x-aura-field-code": "date" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 3 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-accounting-entry-list-for-e-ledger", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/accounting-entry-data-list", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "structure", "declared_type": "AccountingEntryELedgerDto", "payload": "AccountingEntryELedgerDto", "collection": false, "members": [ { "name": "TotalCount", "declared_type": "int", "nullable": false, "collection": false }, { "name": "TotalPage", "declared_type": "int", "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": "int", "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": "int", "nullable": false, "collection": false }, { "name": "BeginDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "EndDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "AccountingEntryList", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_175", "status": 400, "message": { "ar": "يجب أن يكون تاريخ الانتهاء أكبر من تاريخ البداية.", "en": "'endDate' must be bigger than 'beginDate'.", "tr": "'endDate' 'beginDate' den büyük olmalı." }, "message_available": true, "constant_name": "END_DATE_MUST_BE_BIGGER_BEGIN_DATE" }, { "code": "ERR_ACCTNG_235", "status": 400, "message": { "en": "'PageIndex' can't be greater than 'PageCount'", "tr": "'PageIndex' 'PageCount' dan büyük olamaz" }, "message_available": true, "constant_name": "PAGE_INDEX_GREATER_THAN_PAGE_COUNT" } ] } } }, "/api/accounts/{accountId}/blocked-balance": { "get": { "operationId": "aurax-bff-redirect-get-account-blocked-balance", "tags": [ "accounts" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-account-blocked-balance", "description": "Request and response fields are declared on the routing target `get-account-blocked-balance`; this entry declares none of its own.", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "accountId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "blockedAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "blockedAmount" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-account-blocked-balance", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/accounts/{accountId}/blocked-balance", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "structure", "declared_type": "AccountBlockedBalanceDto", "payload": "AccountBlockedBalanceDto", "collection": false, "members": [ { "name": "BlockedAmount", "declared_type": "decimal?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/api/assignments/get-available-limit": { "post": { "operationId": "aurax-bff-dynamic-get-available-limit-bpmn", "tags": [ "assignments" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-available-limit-bpmn", "description": "Request and response fields are declared on the routing target `get-available-limit-bpmn-bff`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "accountProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductId" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "transactionAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "transactionAmount" } }, "required": [ "customerId" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 3, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-available-limit-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/assignments/get-available-limit", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "structure", "declared_type": "AvailableLimitDto", "payload": "AvailableLimitDto", "collection": false, "members": [ { "name": "AllotmentAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "AllotmentAssignmentId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AllotmentAssignmentProductId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AllotmentProductId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AllotmentQueryId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AvailableAllotmentAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerProductRisk", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CustomerRiskId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ProductAllotmentAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "QueryDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "IsLimitAvailable", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/api/check-virtual-iban-bpm": { "post": { "operationId": "aurax-bff-service-dynamic-check-virtual-iban-bpm", "tags": [ "check-virtual-iban-bpm" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-check-virtual-iban-bpm", "description": "Request and response fields are declared on the routing target `check-virtual-iban-bpm`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" } }, "required": [ "customerId" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "accountNumber": { "type": "string", "x-aura-field-code": "accountNumber" }, "virtualIban": { "type": "string", "x-aura-field-code": "virtualIban" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "accountNumber": { "type": "string", "x-aura-field-code": "accountNumber" }, "virtualIban": { "type": "string", "x-aura-field-code": "virtualIban" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "accountNumber": { "type": "string", "x-aura-field-code": "accountNumber" }, "virtualIban": { "type": "string", "x-aura-field-code": "virtualIban" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-check-virtual-iban-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/check-virtual-iban-bpm", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/consents/by-customer-id/{customerId}": { "post": { "operationId": "aurax-bff-service-dynamic-get-consent-by-customer-id", "tags": [ "consents" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-get-consent-by-customer-id", "description": "Request and response fields are declared on the routing target `get-consent-by-customer-id`; this entry declares none of its own.", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" } }, { "name": "context", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "context" } } ], "x-aura-request-binding": { "method": "POST", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 1 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "consentDetails": { "type": "array", "items": { "type": "object", "properties": { "consentId": { "type": "string", "format": "uuid", "x-aura-field-code": "consentId" }, "contactPoint": { "type": "integer", "format": "int32", "x-aura-field-code": "contactPoint" }, "content": { "type": "string", "x-aura-field-code": "content" }, "context": { "type": "string", "x-aura-field-code": "context" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "consentDetailId" } }, "x-aura-field-code": "consentDetails" } }, "consentItemDimensionId": { "type": "string", "format": "uuid", "x-aura-field-code": "consentItemDimensionId" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "consentId" }, "isApproved": { "type": "boolean", "x-aura-field-code": "isApproved" }, "versionNo": { "type": "string", "x-aura-field-code": "consentVersionNo" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-get-consent-by-customer-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/consents/by-customer-id/{customerId}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/create-accounting-entry-bpmn": { "post": { "operationId": "aurax-bff-redirect-create-accounting-entry-bpmn", "tags": [ "create-accounting-entry-bpmn" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "Create Accounting Entry", "description": "Invokes the `aurax-bff-redirect-create-accounting-entry-bpmn` service definition through `POST /api/create-accounting-entry-bpmn`.\n\nRequest and response fields are declared on the routing target `create-accounting-entry-bpmn`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "accountingEntryDefinitionCode": { "type": "string", "x-aura-field-code": "accountingEntryDefinitionCode" }, "accountingEntryDetails": { "type": "array", "items": { "type": "object", "properties": { "accountNumber": { "type": "string", "x-aura-field-code": "accountNumber" }, "accountingEntryDefinitionDetailId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryDefinitionDetailId" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "accountingEntryDetailAmount" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "description": { "type": "string", "x-aura-field-code": "accountingEntryDetailDescription" }, "entryDirection": { "type": "integer", "format": "int32", "x-aura-field-code": "entryDirection" }, "exchangeRate": { "type": "number", "format": "decimal", "x-aura-field-code": "exchangeRate" }, "exchangeSpreadType": { "type": "integer", "format": "int32", "x-aura-field-code": "exchangeSpreadType" }, "financialTransactionCode": { "type": "string", "x-aura-field-code": "financialTransactionCode" }, "glCode": { "type": "string", "x-aura-field-code": "glCode" }, "ordinalPosition": { "type": "integer", "format": "int32", "x-aura-field-code": "ordinalPosition" }, "organizationCode": { "type": "string", "x-aura-field-code": "organizationCode" }, "transactionDate": { "type": "string", "format": "date", "x-aura-field-code": "transactionDate" } }, "required": [ "amount", "currencyNumber", "description", "entryDirection", "exchangeRate", "exchangeSpreadType", "glCode", "ordinalPosition", "organizationCode" ], "x-aura-field-code": "accountingEntryDetails" } }, "bpmFlowCode": { "type": "string", "x-aura-field-code": "bpmFlowCode" }, "description": { "type": "string", "x-aura-field-code": "accountingEntryDescription" }, "entryType": { "type": "integer", "format": "int32", "x-aura-field-code": "accountingEntryType" }, "isApprovalNeeded": { "type": "boolean", "x-aura-field-code": "isApprovalNeeded" }, "transactionDate": { "type": "string", "format": "date", "x-aura-field-code": "transactionDate" }, "userCode": { "type": "string", "x-aura-field-code": "userCode" } }, "required": [ "accountingEntryDetails", "description", "entryType", "transactionDate" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 8, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryId" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-accounting-entry-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/create-accounting-entry-bpmn", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/create-bullet-payment": { "post": { "operationId": "aurax-bff-service-dynamic-create-bullet-payment-bpmn", "tags": [ "create-bullet-payment" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-create-bullet-payment-bpmn", "description": "Request and response fields are declared on the routing target `create-bullet-payment-bpmn`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "bulletAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "bulletAmount" }, "bulletPaymentDate": { "type": "string", "format": "date", "x-aura-field-code": "bulletPaymentDate" }, "loanId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanId" }, "loanReturnPaymentId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanReturnPaymentId" } }, "required": [ "bulletAmount", "bulletPaymentDate", "loanId", "loanReturnPaymentId" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 4, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-create-bullet-payment-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/create-bullet-payment", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/create-verified-customer": { "post": { "operationId": "aurax-bff-service-dynamic-create-verified-customer-bpm", "tags": [ "create-verified-customer" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-create-verified-customer-bpm", "description": "Request and response fields are declared on the routing target `create-verified-customer-bpm`; this entry declares none of its own.", "parameters": [ { "name": "Aura-Partner-Code", "in": "header", "required": false, "schema": { "type": "string", "x-aura-field-code": "partnerCode" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "consents": { "type": "array", "items": { "type": "object", "x-aura-field-code": "consents" } }, "customerSubType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerSubType" }, "email": { "type": "string", "x-aura-field-code": "email" }, "incomes": { "type": "array", "items": { "type": "object", "properties": { "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "estimatedTransactionVolume": { "type": "number", "format": "decimal", "x-aura-field-code": "estimatedTransactionVolume" }, "monthlyAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "monthlyAmount" }, "sourceOfIncome": { "type": "integer", "format": "int32", "x-aura-field-code": "sourceOfIncome" }, "transactionCount": { "type": "integer", "format": "int32", "x-aura-field-code": "transactionCount" } }, "required": [ "currencyNumber", "monthlyAmount", "sourceOfIncome" ], "x-aura-field-code": "incomes" } }, "kycStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "kycStatus" }, "occupations": { "type": "array", "items": { "type": "object", "x-aura-field-code": "occupations" } }, "partnerId": { "type": "string", "format": "uuid", "x-aura-field-code": "partnerId" }, "phoneNumber": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true }, "workingType": { "type": "integer", "format": "int32", "x-aura-field-code": "occupationWorkingType" } }, "required": [ "citizenid", "customerSubType", "incomes", "phoneNumber" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 10, "claim": 0, "form": 0, "header": 1, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "customerNumber": { "type": "string", "x-aura-field-code": "customerNumber" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "customerNumber": { "type": "string", "x-aura-field-code": "customerNumber" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "customerNumber": { "type": "string", "x-aura-field-code": "customerNumber" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-create-verified-customer-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/create-verified-customer", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/create-verified-customer-enqura": { "post": { "operationId": "aurax-bff-service-dynamic-create-verified-customer-enqura-bpm", "tags": [ "create-verified-customer-enqura" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "create-verified-customer-enqura-bpm", "description": "Invokes the `aurax-bff-service-dynamic-create-verified-customer-enqura-bpm` service definition through `POST /api/create-verified-customer-enqura`.\n\nRequest and response fields are declared on the routing target `create-verify-enqura`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "reason": { "type": "string", "x-aura-field-code": "reason" }, "reasonDetail": { "type": "string", "x-aura-field-code": "reasonDetail" }, "reference": { "type": "string", "x-aura-field-code": "referenceId" }, "sessionUId": { "type": "string", "x-aura-field-code": "sessionUId" } }, "required": [ "reason", "reference", "sessionUId" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 4, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-create-verified-customer-enqura-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/create-verified-customer-enqura", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/customer-application/check-by-citizen-id": { "post": { "operationId": "aurax-bff-service-dynamic-check-customer-application-bpmn", "tags": [ "customer-application" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-check-customer-application-bpmn", "description": "Request and response fields are declared on the routing target `check-customer-application-bpmn`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "citizenId": { "type": "string", "x-aura-field-code": "citizenId" } }, "required": [ "citizenId" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "applicationCheckDate": { "type": "string", "format": "date-time", "x-aura-field-code": "applicationCheckDate" }, "applicationCheckStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "applicationCheckStatus" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "applicationCheckDate": { "type": "string", "format": "date-time", "x-aura-field-code": "applicationCheckDate" }, "applicationCheckStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "applicationCheckStatus" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "applicationCheckDate": { "type": "string", "format": "date-time", "x-aura-field-code": "applicationCheckDate" }, "applicationCheckStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "applicationCheckStatus" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-check-customer-application-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/customer-application/check-by-citizen-id", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/customer-application/parameters/by-code/{code}/values": { "get": { "operationId": "aurax-bff-service-dynamic-customer-application-get-parameter-value-list-by-parameter-code", "tags": [ "customer-application" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-customer-application-get-parameter-value-list-by-parameter-code", "description": "Request and response fields are declared on the routing target `customer-application-get-parameter-value-list-by-parameter-code`; this entry declares none of its own.", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "parameterCode" } }, { "name": "includeInactive", "in": "query", "required": false, "schema": { "type": "boolean", "x-aura-field-code": "includeInactive" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 1 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "context": { "type": "string", "x-aura-field-code": "context" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "parameterValueId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "paramKey": { "type": "integer", "format": "int32", "x-aura-field-code": "paramKey" }, "sortOrder": { "type": "number", "x-aura-field-code": "sortOrder" }, "translations": { "type": "array", "items": { "type": "object", "properties": { "context": { "type": "string", "x-aura-field-code": "context" }, "languageCode": { "type": "string", "x-aura-field-code": "languageCode" } }, "x-aura-field-code": "translations" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-customer-application-get-parameter-value-list-by-parameter-code", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/customer-application/parameters/by-code/{code}/values", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "ParameterValueDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ParamKey", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Context", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SortOrder", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "Translations", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_PRMTR_12", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_CODE_NOT_FOUND" } ] } } }, "/api/customer-applications": { "get": { "operationId": "aurax-bff-service-dynamic-get-customer-application-list", "tags": [ "customer-applications" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-get-customer-application-list", "description": "Request and response fields are declared on the routing target `get-customer-application-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "getCustomerApplicationFilter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "applicationAmount" }, "applicationDate": { "type": "string", "format": "date-time", "x-aura-field-code": "applicationDate" }, "applicationNumber": { "type": "string", "x-aura-field-code": "applicationNumber" }, "applicationScore": { "type": "string", "x-aura-field-code": "applicationScore" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "educationLevelOccupationTypeFieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "educationLevelOccupationTypeFieldId" }, "email": { "type": "string", "x-aura-field-code": "email" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerApplicationId" }, "jobOccupationTypeFieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "jobOccupationTypeFieldId" }, "jobTitleOccupationTypeFieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "jobTitleOccupationTypeFieldId" }, "maritalStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "maritalStatus" }, "officePhoneNumber": { "type": "string", "x-aura-field-code": "officePhoneNumber" }, "payDay": { "type": "integer", "format": "int32", "x-aura-field-code": "payDay" }, "phoneNumber": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "status" }, "validityDate": { "type": "string", "format": "date-time", "x-aura-field-code": "validityDate" }, "workingStyleOccupationTypeFieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "workingStyleOccupationTypeFieldId" }, "workplaceSign": { "type": "string", "x-aura-field-code": "workplaceSign" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-get-customer-application-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/customer-applications", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-customer-application-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "CustomerApplicationDto", "collection": true, "members": [ { "name": "ApplicationNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ApplicationDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "ValidityDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "Amount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MaritalStatus", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Status", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "PhoneNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Email", "declared_type": "string", "nullable": false, "collection": false }, { "name": "EducationLevelOccupationTypeFieldId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "JobOccupationTypeFieldId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ApplicationScore", "declared_type": "string", "nullable": false, "collection": false }, { "name": "JobTitleOccupationTypeFieldId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "WorkingStyleOccupationTypeFieldId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "PayDay", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "WorkplaceSign", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OfficePhoneNumber", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/api/customer-applications/by-customer-id/{customerId}": { "get": { "operationId": "aurax-bff-dynamic-get-customer-application-by-customer-id", "tags": [ "customer-applications" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-customer-application-by-customer-id", "description": "Request and response fields are declared on the routing target `get-customer-application-by-customer-id`; this entry declares none of its own.", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" } }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "properties": { "parameters": { "type": "object", "x-aura-field-code": "parameters" } }, "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "applicationAmount" }, "applicationDate": { "type": "string", "format": "date-time", "x-aura-field-code": "applicationDate" }, "applicationNumber": { "type": "string", "x-aura-field-code": "applicationNumber" }, "applicationScore": { "type": "string", "x-aura-field-code": "applicationScore" }, "currencyNumber": { "type": "string", "x-aura-field-code": "customerApplicationCurrencyNumber" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "educationLevelOccupationTypeFieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "educationLevelOccupationTypeFieldId" }, "email": { "type": "string", "x-aura-field-code": "email" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerApplicationId" }, "jobOccupationTypeFieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "jobOccupationTypeFieldId" }, "jobTitleOccupationTypeFieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "jobTitleOccupationTypeFieldId" }, "maritalStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "maritalStatus" }, "officePhoneNumber": { "type": "string", "x-aura-field-code": "officePhoneNumber" }, "payDay": { "type": "integer", "format": "int32", "x-aura-field-code": "payDay" }, "phoneNumber": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "applicationStatus" }, "validityDate": { "type": "string", "format": "date-time", "x-aura-field-code": "validityDate" }, "workingStyleOccupationTypeFieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "workingStyleOccupationTypeFieldId" }, "workplaceSign": { "type": "string", "x-aura-field-code": "workplaceSign" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-customer-application-by-customer-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/customer-applications/by-customer-id/{customerId}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "CustomerApplicationDto", "collection": true, "members": [ { "name": "ApplicationNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ApplicationDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "ValidityDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "Amount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MaritalStatus", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Status", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "PhoneNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Email", "declared_type": "string", "nullable": false, "collection": false }, { "name": "EducationLevelOccupationTypeFieldId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "JobOccupationTypeFieldId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ApplicationScore", "declared_type": "string", "nullable": false, "collection": false }, { "name": "JobTitleOccupationTypeFieldId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "WorkingStyleOccupationTypeFieldId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "PayDay", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "WorkplaceSign", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OfficePhoneNumber", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/api/customer-applications/{id}/evaluation-results": { "get": { "operationId": "aurax-bff-dynamic-get-application-evaluation-result-by-id", "tags": [ "customer-applications" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-application-evaluation-result-by-id", "description": "Request and response fields are declared on the routing target `get-application-evaluation-result-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "customerApplicationId" } }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "code" }, "expression": { "type": "string", "x-aura-field-code": "expression" }, "parameters": { "type": "object", "x-aura-field-code": "filterParameters" } }, "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a collection.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-application-evaluation-result-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/customer-applications/{id}/evaluation-results", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "GetApplicationEvaluationResultDto", "collection": true, "members": [ { "name": "RuleCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "EvaluationStatus", "declared_type": "int", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LAPPLCTN_1", "status": 400, "message": { "ar": "لم يتم العثور على تطبيق العميل. المعرف: {0}", "en": "Customer application cannot be found. :{0}" }, "message_available": true, "constant_name": "CUSTOMER_APPLICATION_NOT_FOUND" } ] } } }, "/api/customer-blockeds/by-account-id/{accountId}": { "get": { "operationId": "aurax-bff-service-dynamic-get-blocked-account-list-by-account-id", "tags": [ "customer-blockeds" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-get-blocked-account-list-by-account-id", "description": "Request and response fields are declared on the routing target `get-blocked-account-list-by-account-id`; this entry declares none of its own.", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "accountId" } }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 3 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "accountBlockeds": { "type": "array", "items": { "type": "object", "properties": { "accountBlockedId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountBlockedId" }, "accountId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountId" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "accountBlockedAmount" }, "amountBlockedCurrency": { "type": "number", "x-aura-field-code": "amountBlockedCurrency" }, "blockedSubType": { "type": "integer", "format": "int32", "x-aura-field-code": "blockedSubType" }, "exchangeRate": { "type": "number", "format": "decimal", "x-aura-field-code": "exchangeRate" } }, "x-aura-field-code": "accountBlockeds" } }, "blockedAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "blockedAmount" }, "blockedCurrencyNumber": { "type": "string", "x-aura-field-code": "blockedCurrencyNumber" }, "blockedDate": { "type": "string", "format": "date", "x-aura-field-code": "blockedDate" }, "blockedDueDate": { "type": "string", "format": "date", "x-aura-field-code": "blockedDueDate" }, "blockedItemId": { "type": "string", "format": "uuid", "x-aura-field-code": "blockedItemId" }, "blockedType": { "type": "integer", "format": "int32", "x-aura-field-code": "blockedType" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "description": { "type": "string", "x-aura-field-code": "description" }, "direction": { "type": "string", "x-aura-field-code": "direction" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerBlockedId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "unblockedDate": { "type": "string", "format": "date-time", "x-aura-field-code": "unblockedDate" }, "unblockedReason": { "type": "string", "x-aura-field-code": "unblockedReason" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-get-blocked-account-list-by-account-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/customer-blockeds/by-account-id/{accountId}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "note": "Platform-provided behaviours declared on the routing target `get-blocked-account-list-by-account-id`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "CustomerBlockedDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "BlockedItemId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "BlockedAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "BlockedCurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BlockedType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "BlockedDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "BlockedDueDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "UnblockedDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "UnblockedReason", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "Direction", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AccountBlockeds", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." } } }, "/api/customer-blockeds/by-customer-id/{customerId}": { "get": { "operationId": "aurax-bff-service-dynamic-get-customer-blocked-list-by-customer-id", "tags": [ "customer-blockeds" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-get-customer-blocked-list-by-customer-id", "description": "Request and response fields are declared on the routing target `get-customer-blocked-list-by-customer-id`; this entry declares none of its own.", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" } }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 3 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "accountBlockeds": { "type": "array", "items": { "type": "object", "properties": { "accountBlockedId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountBlockedId" }, "accountId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountId" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "accountBlockedAmount" }, "amountBlockedCurrency": { "type": "number", "x-aura-field-code": "amountBlockedCurrency" }, "exchangeRate": { "type": "number", "format": "decimal", "x-aura-field-code": "exchangeRate" } }, "x-aura-field-code": "accountBlockeds" } }, "blockedAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "blockedAmount" }, "blockedCurrencyNumber": { "type": "string", "x-aura-field-code": "blockedCurrencyNumber" }, "blockedDate": { "type": "string", "format": "date", "x-aura-field-code": "blockedDate" }, "blockedDueDate": { "type": "string", "format": "date", "x-aura-field-code": "blockedDueDate" }, "blockedItemId": { "type": "string", "format": "uuid", "x-aura-field-code": "blockedItemId" }, "blockedSubType": { "type": "integer", "format": "int32", "x-aura-field-code": "blockedSubType" }, "blockedType": { "type": "integer", "format": "int32", "x-aura-field-code": "blockedType" }, "customerBlockedId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerBlockedId" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "description": { "type": "string", "x-aura-field-code": "description" }, "direction": { "type": "string", "x-aura-field-code": "direction" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "unblockedDate": { "type": "string", "format": "date-time", "x-aura-field-code": "unblockedDate" }, "unblockedReason": { "type": "string", "x-aura-field-code": "unblockedReason" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-get-customer-blocked-list-by-customer-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/customer-blockeds/by-customer-id/{customerId}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "note": "Platform-provided behaviours declared on the routing target `get-customer-blocked-list-by-customer-id`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "CustomerBlockedDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "BlockedItemId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "BlockedAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "BlockedCurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BlockedType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "BlockedDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "BlockedDueDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "UnblockedDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "UnblockedReason", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "Direction", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AccountBlockeds", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." } } }, "/api/customers/bnpl-virtual-cards/by-card-token/{cardToken}": { "put": { "operationId": "aurax-bff-dynamic-update-bnpl-virtual-card-by-token", "tags": [ "customers" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "update-bnpl-virtual-card-by-token", "description": "Invokes the `aurax-bff-dynamic-update-bnpl-virtual-card-by-token` service definition through `PUT /api/customers/bnpl-virtual-cards/by-card-token/{cardToken}`.\n\nRequest and response fields are declared on the routing target `update-bnpl-virtual-card-by-token`; this entry declares none of its own.", "parameters": [ { "name": "cardToken", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "cardToken" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "x-aura-field-code": "bnplVirtualCardStatusContext" } }, "required": [ "status" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-update-bnpl-virtual-card-by-token", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/customers/bnpl-virtual-cards/by-card-token/{cardToken}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/customers/by-citizenid/{citizenId}/information": { "get": { "operationId": "aurax-bff-dynamic-get-customer-information-by-citizen-id", "tags": [ "customers" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-customer-information-by-citizen-id", "description": "Request and response fields are declared on the routing target `get-customer-information-by-citizen-id`; this entry declares none of its own.", "parameters": [ { "name": "citizenId", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "citizenId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "addresses": { "type": "object", "properties": { "addressName": { "type": "string", "x-aura-field-code": "addressName" }, "addressType": { "type": "string", "x-aura-field-code": "addressTypeContext" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" } }, "x-aura-field-code": "tempString", "x-aura-declared-type": "string" }, "birthDate": { "type": "string", "format": "date", "x-aura-field-code": "date" }, "birthPlace": { "type": "string", "x-aura-field-code": "birthPlace" }, "citizenId": { "type": "string", "x-aura-field-code": "citizenId" }, "citizenIdType": { "type": "string", "x-aura-field-code": "citizenIdType" }, "consents": { "type": "object", "properties": { "consentItemCode": { "type": "string", "x-aura-field-code": "consentItemCode" }, "consentItemDescription": { "type": "string", "x-aura-field-code": "consentItemDescription" }, "consentItemIsActive": { "type": "boolean", "x-aura-field-code": "consentItemIsActive" }, "consentItemName": { "type": "string", "x-aura-field-code": "consentItemName" }, "contactPoint": { "type": "string", "x-aura-field-code": "contactPointContext" }, "context": { "type": "string", "x-aura-field-code": "context" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "isApproved": { "type": "boolean", "x-aura-field-code": "isApproved" }, "transactionType": { "type": "string", "x-aura-field-code": "transactionTypeContext" } }, "x-aura-field-code": "tempString", "x-aura-declared-type": "string" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "customerNumber": { "type": "string", "x-aura-field-code": "customerNumber" }, "customerType": { "type": "string", "x-aura-field-code": "customerTypeContext" }, "emails": { "type": "string", "x-aura-field-code": "tempString" }, "fullName": { "type": "string", "x-aura-field-code": "fullName" }, "genderName": { "type": "string", "x-aura-field-code": "genderName" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "loans": { "type": "string", "x-aura-field-code": "tempString" }, "maritalStatus": { "type": "string", "x-aura-field-code": "maritalStatusTypeContext" }, "motherMaidenSurname": { "type": "string", "x-aura-field-code": "motherMaidenSurname" }, "phones": { "type": "string", "x-aura-field-code": "tempString" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-customer-information-by-citizen-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/customers/by-citizenid/{citizenId}/information", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/customers/by-citizenid/{citizenid}/customernumber": { "get": { "operationId": "aurax-bff-service-dynamic-get-customer-number-by-citizenid", "tags": [ "customers" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-get-customer-number-by-citizenid", "description": "Request and response fields are declared on the routing target `get-customer-number-by-citizenid`; this entry declares none of its own.", "parameters": [ { "name": "citizenid", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "customerDatas": { "type": "array", "items": { "type": "object", "properties": { "customerNumber": { "type": "string", "x-aura-field-code": "customerNumber" }, "customerSubType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerSubType" }, "customerType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerType" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "isCustomer": { "type": "boolean", "x-aura-field-code": "isCustomer" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" } }, "x-aura-field-code": "customerDatas" } }, "customerNumber": { "type": "string", "x-aura-field-code": "customerNumber" }, "customerSubType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerSubType" }, "customerType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerType" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "isCustomer": { "type": "boolean", "x-aura-field-code": "isCustomer" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-get-customer-number-by-citizenid", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/customers/by-citizenid/{citizenid}/customernumber", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CustomerId", "declared_type": null, "nullable": true, "collection": false }, { "name": "Citizenid", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/customers/individual-customers": { "get": { "operationId": "aurax-bff-redirect-get-individual-customer-list", "tags": [ "customers" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-individual-customer-list", "description": "Request and response fields are declared on the routing target `get-individual-customer-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "addressDetails": { "type": "array", "items": { "type": "object", "properties": { "fieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "fieldId" }, "fieldValue": { "type": "string", "x-aura-field-code": "fieldValue" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "addressDetailId" } }, "x-aura-field-code": "addressDetails" } }, "addressName": { "type": "string", "x-aura-field-code": "addressName" }, "addressText": { "type": "string", "x-aura-field-code": "addressText" }, "addressType": { "type": "integer", "format": "int32", "x-aura-field-code": "addressType" }, "addressTypeId": { "type": "string", "format": "uuid", "x-aura-field-code": "addressTypeId" }, "addresses": { "type": "array", "items": { "type": "object", "x-aura-field-code": "addresses" } }, "birthCountryId": { "type": "integer", "format": "int32", "x-aura-field-code": "birthCountryId" }, "birthDate": { "type": "string", "format": "date", "x-aura-field-code": "birthDate" }, "birthPlace": { "type": "string", "x-aura-field-code": "birthPlace" }, "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "citizenidType": { "type": "integer", "format": "int32", "x-aura-field-code": "citizenidType" }, "closeDate": { "type": "string", "format": "date", "x-aura-field-code": "closeDate" }, "closedDate": { "type": "string", "format": "date", "x-aura-field-code": "closedDate" }, "closedReason": { "type": "integer", "format": "int32", "x-aura-field-code": "closedReason" }, "consent": { "x-aura-type": "unresolved" }, "consentDetails": { "type": "array", "items": { "type": "object", "properties": { "consentId": { "type": "string", "format": "uuid", "x-aura-field-code": "consentId" }, "contactPoint": { "type": "integer", "format": "int32", "x-aura-field-code": "contactPoint" }, "content": { "type": "string", "x-aura-field-code": "content" }, "context": { "type": "string", "x-aura-field-code": "context" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "consentDetailId" } }, "x-aura-field-code": "consentDetails" } }, "consentItemDimensionId": { "type": "string", "format": "uuid", "x-aura-field-code": "consentItemDimensionId" }, "consentItemId": { "type": "string", "format": "uuid", "x-aura-field-code": "consentItemId" }, "consentItemIds": { "type": "array", "items": { "type": "string", "format": "uuid", "x-aura-field-code": "consentItemGuidIds" } }, "consentSourceId": { "x-aura-type": "unresolved" }, "corporateCustomer": { "type": "object", "properties": { "isSeller": { "type": "boolean", "x-aura-field-code": "isSeller" }, "legalOrganizationType": { "type": "integer", "format": "int32", "x-aura-field-code": "legalOrganizationType" }, "naceId": { "type": "string", "format": "uuid", "x-aura-field-code": "naceId" }, "organizationType": { "type": "integer", "format": "int32", "x-aura-field-code": "organizationType" }, "registryOfficeCountryDivisionId": { "type": "integer", "format": "int32", "x-aura-field-code": "registryOfficeCountryDivisionId" }, "registryOfficeCountryId": { "type": "integer", "format": "int32", "x-aura-field-code": "registryOfficeCountryId" }, "shortName": { "type": "string", "x-aura-field-code": "shortName" }, "subOrganizationType": { "type": "integer", "format": "int32", "x-aura-field-code": "subOrganizationType" }, "taxOfficeId": { "type": "string", "format": "uuid", "x-aura-field-code": "taxOfficeId" }, "title": { "type": "string", "x-aura-field-code": "title" }, "tradeRegisterNumber": { "type": "string", "x-aura-field-code": "tradeRegisterNumber" } }, "x-aura-field-code": "corporateCustomer" }, "createdDate": { "type": "string", "format": "date-time", "x-aura-field-code": "createdDate" }, "createdOrganizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "createdOrganizationId" }, "customerAttributes": { "type": "array", "items": { "type": "object", "properties": { "attributeKey": { "type": "integer", "format": "int32", "x-aura-field-code": "attributeKey" }, "attributeValue": { "type": "string", "x-aura-field-code": "attributeValue" }, "beginDate": { "type": "string", "format": "date", "x-aura-field-code": "attributeBeginDate" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerAttributeId" }, "isDigital": { "type": "boolean", "x-aura-field-code": "isDigital" } }, "x-aura-field-code": "customerAttributes" } }, "customerAuthorities": { "type": "array", "items": { "type": "object", "properties": { "authorityType": { "type": "integer", "format": "int32", "x-aura-field-code": "authorityType" }, "description": { "type": "string", "x-aura-field-code": "description" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "fromCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "fromCustomerId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerAuthorityId" }, "startDate": { "type": "string", "format": "date-time", "x-aura-field-code": "startDate" }, "toCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "toCustomerId" } }, "x-aura-field-code": "customerAuthorities" } }, "customerChecks": { "type": "array", "items": { "type": "object", "properties": { "changedType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerCheckChangedType" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerCheckId" } }, "x-aura-field-code": "customerChecks" } }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "customerNumber": { "type": "string", "x-aura-field-code": "customerNumber" }, "customerRelationships": { "type": "array", "items": { "type": "object", "properties": { "customerShareholders": { "type": "array", "items": { "type": "object", "properties": { "customerRelationshipId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerRelationshipId" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerShareholderId" }, "shareRate": { "type": "number", "format": "decimal", "x-aura-field-code": "shareRate" }, "startDate": { "type": "string", "format": "date-time", "x-aura-field-code": "startDate" } }, "x-aura-field-code": "customerShareholders" } }, "description": { "type": "string", "x-aura-field-code": "authorityDescription" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "fromCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "fromCustomerId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerRelationshipId" }, "relationType": { "type": "integer", "format": "int32", "x-aura-field-code": "relationType" }, "startDate": { "type": "string", "format": "date-time", "x-aura-field-code": "startDate" }, "toCitizenid": { "type": "string", "x-aura-field-code": "toCitizenid" }, "toCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "toCustomerId" } }, "x-aura-field-code": "customerRelationships" } }, "customerStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "customerStatus" }, "customerSubType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerSubType" }, "customerTaxpayers": { "type": "array", "items": { "type": "object", "properties": { "companyType": { "x-aura-type": "unresolved" }, "countryId": { "type": "integer", "format": "int32", "x-aura-field-code": "countryId" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "description": { "type": "string", "x-aura-field-code": "description" }, "fatcaReason": { "x-aura-type": "unresolved" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "taxpayerId" }, "taxNumber": { "type": "string", "x-aura-field-code": "taxNumber" }, "taxNumberNotReason": { "x-aura-type": "unresolved" }, "taxpayerClass": { "x-aura-type": "unresolved" }, "taxpayerPersonType": { "x-aura-type": "unresolved" }, "taxpayerType": { "type": "integer", "format": "int32", "x-aura-field-code": "taxpayerType" } }, "x-aura-field-code": "customerTaxpayers" } }, "customerType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerType" }, "deathDate": { "type": "string", "format": "date", "x-aura-field-code": "deathDate" }, "emails": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string", "x-aura-field-code": "email" }, "id": { "x-aura-type": "unresolved" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "isVerified": { "type": "boolean", "x-aura-field-code": "isVerified" } }, "x-aura-field-code": "emails" } }, "establishCountryDivisionId": { "type": "integer", "format": "int32", "x-aura-field-code": "establishCountryDivisionId" }, "establishCountryId": { "type": "integer", "format": "int32", "x-aura-field-code": "establishCountryId" }, "establishDate": { "type": "string", "format": "date", "x-aura-field-code": "establishDate" }, "fatherName": { "type": "string", "x-aura-field-code": "fatherName" }, "freeZone": { "type": "integer", "format": "int32", "x-aura-field-code": "freeZone" }, "fullName": { "type": "string", "x-aura-field-code": "fullName" }, "gender": { "type": "integer", "format": "int32", "x-aura-field-code": "gender" }, "givenName": { "type": "string", "x-aura-field-code": "givenName" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "identities": { "type": "array", "items": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "identityCardId" }, "identityDetails": { "type": "array", "items": { "type": "object", "properties": { "fieldValue": { "type": "string", "x-aura-field-code": "fieldValue" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "identityDetails_identityTypeFieldId" }, "identityTypeFieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "identityTypeFieldId" } }, "x-aura-field-code": "identityDetails" } }, "identityTypeId": { "type": "string", "format": "uuid", "x-aura-field-code": "identityTypeId" } }, "x-aura-field-code": "identities" } }, "individualCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "individualCustomerId" }, "isApproved": { "type": "boolean", "x-aura-field-code": "isApproved" }, "isBlackList": { "type": "boolean", "x-aura-field-code": "isBlackList" }, "isCardDeliveryAddress": { "type": "boolean", "x-aura-field-code": "isCardDeliveryAddress" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "isFreeZoneCustomer": { "type": "boolean", "x-aura-field-code": "isFreeZoneCustomer" }, "isPoliticallyExposed": { "type": "boolean", "x-aura-field-code": "isPoliticallyExposed" }, "isSigned": { "type": "boolean", "x-aura-field-code": "isSigned" }, "isVerified": { "type": "boolean", "x-aura-field-code": "isVerified" }, "maidenSurname": { "type": "string", "x-aura-field-code": "maidenSurname" }, "mainOrganizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "mainOrganizationId" }, "maritalStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "maritalStatus" }, "middleName": { "type": "string", "x-aura-field-code": "middleName" }, "motherMaidenSurname": { "type": "string", "x-aura-field-code": "motherMaidenSurname" }, "motherName": { "type": "string", "x-aura-field-code": "motherName" }, "naceId": { "type": "string", "format": "uuid", "x-aura-field-code": "naceId" }, "name": { "type": "string", "x-aura-field-code": "firstName" }, "nationalities": { "type": "array", "items": { "type": "object", "properties": { "countryId": { "type": "integer", "format": "int32", "x-aura-field-code": "countryId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "nationalities_nationalityId" }, "priority": { "type": "integer", "format": "int32", "x-aura-field-code": "priority" } }, "x-aura-field-code": "nationalities" } }, "occupations": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "occupationId" }, "occupationTypeFieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "occupationTypeFieldId" }, "occupationTypeFieldValue": { "type": "string", "x-aura-field-code": "occupationTypeFieldValue" }, "occupationTypeId": { "type": "string", "format": "uuid", "x-aura-field-code": "occupationTypeId" } }, "x-aura-field-code": "occupations" } }, "onboardedDate": { "x-aura-type": "unresolved" }, "onboardedOrganizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "onboardedOrganizationId" }, "organizationType": { "type": "integer", "format": "int32", "x-aura-field-code": "organizationType" }, "phones": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "phoneId" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "isVerified": { "type": "boolean", "x-aura-field-code": "isVerified" }, "phoneNumber": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true }, "phoneType": { "type": "integer", "format": "int32", "x-aura-field-code": "phoneType" } }, "x-aura-field-code": "phones" } }, "profiles": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "profileId" }, "profile": { "type": "integer", "format": "int32", "x-aura-field-code": "profile" } }, "x-aura-field-code": "profiles" } }, "pwfCustomerId": { "type": "integer", "format": "int32", "x-aura-field-code": "pwfCustomerId" }, "recordType": { "type": "integer", "format": "int32", "x-aura-field-code": "recordType" }, "registryOfficeCountryDivisionId": { "type": "integer", "format": "int32", "x-aura-field-code": "registryOfficeCountryDivisionId" }, "registryOfficeCountryId": { "type": "integer", "format": "int32", "x-aura-field-code": "registryOfficeCountryId" }, "residency": { "type": "integer", "format": "int32", "x-aura-field-code": "residency" }, "residentials": { "type": "array", "items": { "type": "object", "properties": { "countryId": { "type": "integer", "format": "int32", "x-aura-field-code": "countryId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "residentialId" }, "priority": { "type": "integer", "format": "int32", "x-aura-field-code": "priority" } }, "x-aura-field-code": "residentials" } }, "segmentName": { "type": "string", "x-aura-field-code": "segmentName" }, "separatorMark": { "type": "string", "x-aura-field-code": "separatorMark" }, "subOrganizationType": { "type": "integer", "format": "int32", "x-aura-field-code": "subOrganizationType" }, "surname": { "type": "string", "x-aura-field-code": "surname", "x-aura-maskable": true }, "transactionId": { "type": "string", "format": "uuid", "x-aura-field-code": "transactionId" }, "unlimitedCompanyCustomer": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "establishedDate": { "type": "string", "format": "date", "x-aura-field-code": "establishedDate" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "unlimitedCompanyCustomerId" }, "taxOfficeId": { "type": "string", "format": "uuid", "x-aura-field-code": "taxOfficeId" }, "title": { "type": "string", "x-aura-field-code": "title" }, "unlimitedCompanyCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "unlimitedCompanyCustomerId" } }, "x-aura-field-code": "unlimitedCompanyCustomer" }, "versionNo": { "type": "integer", "format": "int32", "x-aura-field-code": "versionNo" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "addressDetails": { "type": "array", "items": { "type": "object", "properties": { "fieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "fieldId" }, "fieldValue": { "type": "string", "x-aura-field-code": "fieldValue" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "addressDetailId" } }, "x-aura-field-code": "addressDetails" } }, "addressName": { "type": "string", "x-aura-field-code": "addressName" }, "addressText": { "type": "string", "x-aura-field-code": "addressText" }, "addressType": { "type": "integer", "format": "int32", "x-aura-field-code": "addressType" }, "addressTypeId": { "type": "string", "format": "uuid", "x-aura-field-code": "addressTypeId" }, "addresses": { "type": "array", "items": { "type": "object", "x-aura-field-code": "addresses" } }, "birthCountryId": { "type": "integer", "format": "int32", "x-aura-field-code": "birthCountryId" }, "birthDate": { "type": "string", "format": "date", "x-aura-field-code": "birthDate" }, "birthPlace": { "type": "string", "x-aura-field-code": "birthPlace" }, "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "citizenidType": { "type": "integer", "format": "int32", "x-aura-field-code": "citizenidType" }, "closeDate": { "type": "string", "format": "date", "x-aura-field-code": "closeDate" }, "closedDate": { "type": "string", "format": "date", "x-aura-field-code": "closedDate" }, "closedReason": { "type": "integer", "format": "int32", "x-aura-field-code": "closedReason" }, "consent": { "x-aura-type": "unresolved" }, "consentDetails": { "type": "array", "items": { "type": "object", "properties": { "consentId": { "type": "string", "format": "uuid", "x-aura-field-code": "consentId" }, "contactPoint": { "type": "integer", "format": "int32", "x-aura-field-code": "contactPoint" }, "content": { "type": "string", "x-aura-field-code": "content" }, "context": { "type": "string", "x-aura-field-code": "context" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "consentDetailId" } }, "x-aura-field-code": "consentDetails" } }, "consentItemDimensionId": { "type": "string", "format": "uuid", "x-aura-field-code": "consentItemDimensionId" }, "consentItemId": { "type": "string", "format": "uuid", "x-aura-field-code": "consentItemId" }, "consentItemIds": { "type": "array", "items": { "type": "string", "format": "uuid", "x-aura-field-code": "consentItemGuidIds" } }, "consentSourceId": { "x-aura-type": "unresolved" }, "corporateCustomer": { "type": "object", "properties": { "isSeller": { "type": "boolean", "x-aura-field-code": "isSeller" }, "legalOrganizationType": { "type": "integer", "format": "int32", "x-aura-field-code": "legalOrganizationType" }, "naceId": { "type": "string", "format": "uuid", "x-aura-field-code": "naceId" }, "organizationType": { "type": "integer", "format": "int32", "x-aura-field-code": "organizationType" }, "registryOfficeCountryDivisionId": { "type": "integer", "format": "int32", "x-aura-field-code": "registryOfficeCountryDivisionId" }, "registryOfficeCountryId": { "type": "integer", "format": "int32", "x-aura-field-code": "registryOfficeCountryId" }, "shortName": { "type": "string", "x-aura-field-code": "shortName" }, "subOrganizationType": { "type": "integer", "format": "int32", "x-aura-field-code": "subOrganizationType" }, "taxOfficeId": { "type": "string", "format": "uuid", "x-aura-field-code": "taxOfficeId" }, "title": { "type": "string", "x-aura-field-code": "title" }, "tradeRegisterNumber": { "type": "string", "x-aura-field-code": "tradeRegisterNumber" } }, "x-aura-field-code": "corporateCustomer" }, "createdDate": { "type": "string", "format": "date-time", "x-aura-field-code": "createdDate" }, "createdOrganizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "createdOrganizationId" }, "customerAttributes": { "type": "array", "items": { "type": "object", "properties": { "attributeKey": { "type": "integer", "format": "int32", "x-aura-field-code": "attributeKey" }, "attributeValue": { "type": "string", "x-aura-field-code": "attributeValue" }, "beginDate": { "type": "string", "format": "date", "x-aura-field-code": "attributeBeginDate" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerAttributeId" }, "isDigital": { "type": "boolean", "x-aura-field-code": "isDigital" } }, "x-aura-field-code": "customerAttributes" } }, "customerAuthorities": { "type": "array", "items": { "type": "object", "properties": { "authorityType": { "type": "integer", "format": "int32", "x-aura-field-code": "authorityType" }, "description": { "type": "string", "x-aura-field-code": "description" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "fromCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "fromCustomerId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerAuthorityId" }, "startDate": { "type": "string", "format": "date-time", "x-aura-field-code": "startDate" }, "toCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "toCustomerId" } }, "x-aura-field-code": "customerAuthorities" } }, "customerChecks": { "type": "array", "items": { "type": "object", "properties": { "changedType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerCheckChangedType" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerCheckId" } }, "x-aura-field-code": "customerChecks" } }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "customerNumber": { "type": "string", "x-aura-field-code": "customerNumber" }, "customerRelationships": { "type": "array", "items": { "type": "object", "properties": { "customerShareholders": { "type": "array", "items": { "type": "object", "properties": { "customerRelationshipId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerRelationshipId" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerShareholderId" }, "shareRate": { "type": "number", "format": "decimal", "x-aura-field-code": "shareRate" }, "startDate": { "type": "string", "format": "date-time", "x-aura-field-code": "startDate" } }, "x-aura-field-code": "customerShareholders" } }, "description": { "type": "string", "x-aura-field-code": "authorityDescription" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "fromCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "fromCustomerId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerRelationshipId" }, "relationType": { "type": "integer", "format": "int32", "x-aura-field-code": "relationType" }, "startDate": { "type": "string", "format": "date-time", "x-aura-field-code": "startDate" }, "toCitizenid": { "type": "string", "x-aura-field-code": "toCitizenid" }, "toCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "toCustomerId" } }, "x-aura-field-code": "customerRelationships" } }, "customerStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "customerStatus" }, "customerSubType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerSubType" }, "customerTaxpayers": { "type": "array", "items": { "type": "object", "properties": { "companyType": { "x-aura-type": "unresolved" }, "countryId": { "type": "integer", "format": "int32", "x-aura-field-code": "countryId" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "description": { "type": "string", "x-aura-field-code": "description" }, "fatcaReason": { "x-aura-type": "unresolved" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "taxpayerId" }, "taxNumber": { "type": "string", "x-aura-field-code": "taxNumber" }, "taxNumberNotReason": { "x-aura-type": "unresolved" }, "taxpayerClass": { "x-aura-type": "unresolved" }, "taxpayerPersonType": { "x-aura-type": "unresolved" }, "taxpayerType": { "type": "integer", "format": "int32", "x-aura-field-code": "taxpayerType" } }, "x-aura-field-code": "customerTaxpayers" } }, "customerType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerType" }, "deathDate": { "type": "string", "format": "date", "x-aura-field-code": "deathDate" }, "emails": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string", "x-aura-field-code": "email" }, "id": { "x-aura-type": "unresolved" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "isVerified": { "type": "boolean", "x-aura-field-code": "isVerified" } }, "x-aura-field-code": "emails" } }, "establishCountryDivisionId": { "type": "integer", "format": "int32", "x-aura-field-code": "establishCountryDivisionId" }, "establishCountryId": { "type": "integer", "format": "int32", "x-aura-field-code": "establishCountryId" }, "establishDate": { "type": "string", "format": "date", "x-aura-field-code": "establishDate" }, "fatherName": { "type": "string", "x-aura-field-code": "fatherName" }, "freeZone": { "type": "integer", "format": "int32", "x-aura-field-code": "freeZone" }, "fullName": { "type": "string", "x-aura-field-code": "fullName" }, "gender": { "type": "integer", "format": "int32", "x-aura-field-code": "gender" }, "givenName": { "type": "string", "x-aura-field-code": "givenName" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "identities": { "type": "array", "items": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "identityCardId" }, "identityDetails": { "type": "array", "items": { "type": "object", "properties": { "fieldValue": { "type": "string", "x-aura-field-code": "fieldValue" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "identityDetails_identityTypeFieldId" }, "identityTypeFieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "identityTypeFieldId" } }, "x-aura-field-code": "identityDetails" } }, "identityTypeId": { "type": "string", "format": "uuid", "x-aura-field-code": "identityTypeId" } }, "x-aura-field-code": "identities" } }, "individualCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "individualCustomerId" }, "isApproved": { "type": "boolean", "x-aura-field-code": "isApproved" }, "isBlackList": { "type": "boolean", "x-aura-field-code": "isBlackList" }, "isCardDeliveryAddress": { "type": "boolean", "x-aura-field-code": "isCardDeliveryAddress" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "isFreeZoneCustomer": { "type": "boolean", "x-aura-field-code": "isFreeZoneCustomer" }, "isPoliticallyExposed": { "type": "boolean", "x-aura-field-code": "isPoliticallyExposed" }, "isSigned": { "type": "boolean", "x-aura-field-code": "isSigned" }, "isVerified": { "type": "boolean", "x-aura-field-code": "isVerified" }, "maidenSurname": { "type": "string", "x-aura-field-code": "maidenSurname" }, "mainOrganizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "mainOrganizationId" }, "maritalStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "maritalStatus" }, "middleName": { "type": "string", "x-aura-field-code": "middleName" }, "motherMaidenSurname": { "type": "string", "x-aura-field-code": "motherMaidenSurname" }, "motherName": { "type": "string", "x-aura-field-code": "motherName" }, "naceId": { "type": "string", "format": "uuid", "x-aura-field-code": "naceId" }, "name": { "type": "string", "x-aura-field-code": "firstName" }, "nationalities": { "type": "array", "items": { "type": "object", "properties": { "countryId": { "type": "integer", "format": "int32", "x-aura-field-code": "countryId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "nationalities_nationalityId" }, "priority": { "type": "integer", "format": "int32", "x-aura-field-code": "priority" } }, "x-aura-field-code": "nationalities" } }, "occupations": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "occupationId" }, "occupationTypeFieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "occupationTypeFieldId" }, "occupationTypeFieldValue": { "type": "string", "x-aura-field-code": "occupationTypeFieldValue" }, "occupationTypeId": { "type": "string", "format": "uuid", "x-aura-field-code": "occupationTypeId" } }, "x-aura-field-code": "occupations" } }, "onboardedDate": { "x-aura-type": "unresolved" }, "onboardedOrganizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "onboardedOrganizationId" }, "organizationType": { "type": "integer", "format": "int32", "x-aura-field-code": "organizationType" }, "phones": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "phoneId" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "isVerified": { "type": "boolean", "x-aura-field-code": "isVerified" }, "phoneNumber": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true }, "phoneType": { "type": "integer", "format": "int32", "x-aura-field-code": "phoneType" } }, "x-aura-field-code": "phones" } }, "profiles": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "profileId" }, "profile": { "type": "integer", "format": "int32", "x-aura-field-code": "profile" } }, "x-aura-field-code": "profiles" } }, "pwfCustomerId": { "type": "integer", "format": "int32", "x-aura-field-code": "pwfCustomerId" }, "recordType": { "type": "integer", "format": "int32", "x-aura-field-code": "recordType" }, "registryOfficeCountryDivisionId": { "type": "integer", "format": "int32", "x-aura-field-code": "registryOfficeCountryDivisionId" }, "registryOfficeCountryId": { "type": "integer", "format": "int32", "x-aura-field-code": "registryOfficeCountryId" }, "residency": { "type": "integer", "format": "int32", "x-aura-field-code": "residency" }, "residentials": { "type": "array", "items": { "type": "object", "properties": { "countryId": { "type": "integer", "format": "int32", "x-aura-field-code": "countryId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "residentialId" }, "priority": { "type": "integer", "format": "int32", "x-aura-field-code": "priority" } }, "x-aura-field-code": "residentials" } }, "segmentName": { "type": "string", "x-aura-field-code": "segmentName" }, "separatorMark": { "type": "string", "x-aura-field-code": "separatorMark" }, "subOrganizationType": { "type": "integer", "format": "int32", "x-aura-field-code": "subOrganizationType" }, "surname": { "type": "string", "x-aura-field-code": "surname", "x-aura-maskable": true }, "transactionId": { "type": "string", "format": "uuid", "x-aura-field-code": "transactionId" }, "unlimitedCompanyCustomer": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "establishedDate": { "type": "string", "format": "date", "x-aura-field-code": "establishedDate" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "unlimitedCompanyCustomerId" }, "taxOfficeId": { "type": "string", "format": "uuid", "x-aura-field-code": "taxOfficeId" }, "title": { "type": "string", "x-aura-field-code": "title" }, "unlimitedCompanyCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "unlimitedCompanyCustomerId" } }, "x-aura-field-code": "unlimitedCompanyCustomer" }, "versionNo": { "type": "integer", "format": "int32", "x-aura-field-code": "versionNo" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "addressDetails": { "type": "array", "items": { "type": "object", "properties": { "fieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "fieldId" }, "fieldValue": { "type": "string", "x-aura-field-code": "fieldValue" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "addressDetailId" } }, "x-aura-field-code": "addressDetails" } }, "addressName": { "type": "string", "x-aura-field-code": "addressName" }, "addressText": { "type": "string", "x-aura-field-code": "addressText" }, "addressType": { "type": "integer", "format": "int32", "x-aura-field-code": "addressType" }, "addressTypeId": { "type": "string", "format": "uuid", "x-aura-field-code": "addressTypeId" }, "addresses": { "type": "array", "items": { "type": "object", "x-aura-field-code": "addresses" } }, "birthCountryId": { "type": "integer", "format": "int32", "x-aura-field-code": "birthCountryId" }, "birthDate": { "type": "string", "format": "date", "x-aura-field-code": "birthDate" }, "birthPlace": { "type": "string", "x-aura-field-code": "birthPlace" }, "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "citizenidType": { "type": "integer", "format": "int32", "x-aura-field-code": "citizenidType" }, "closeDate": { "type": "string", "format": "date", "x-aura-field-code": "closeDate" }, "closedDate": { "type": "string", "format": "date", "x-aura-field-code": "closedDate" }, "closedReason": { "type": "integer", "format": "int32", "x-aura-field-code": "closedReason" }, "consent": { "x-aura-type": "unresolved" }, "consentDetails": { "type": "array", "items": { "type": "object", "properties": { "consentId": { "type": "string", "format": "uuid", "x-aura-field-code": "consentId" }, "contactPoint": { "type": "integer", "format": "int32", "x-aura-field-code": "contactPoint" }, "content": { "type": "string", "x-aura-field-code": "content" }, "context": { "type": "string", "x-aura-field-code": "context" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "consentDetailId" } }, "x-aura-field-code": "consentDetails" } }, "consentItemDimensionId": { "type": "string", "format": "uuid", "x-aura-field-code": "consentItemDimensionId" }, "consentItemId": { "type": "string", "format": "uuid", "x-aura-field-code": "consentItemId" }, "consentItemIds": { "type": "array", "items": { "type": "string", "format": "uuid", "x-aura-field-code": "consentItemGuidIds" } }, "consentSourceId": { "x-aura-type": "unresolved" }, "corporateCustomer": { "type": "object", "properties": { "isSeller": { "type": "boolean", "x-aura-field-code": "isSeller" }, "legalOrganizationType": { "type": "integer", "format": "int32", "x-aura-field-code": "legalOrganizationType" }, "naceId": { "type": "string", "format": "uuid", "x-aura-field-code": "naceId" }, "organizationType": { "type": "integer", "format": "int32", "x-aura-field-code": "organizationType" }, "registryOfficeCountryDivisionId": { "type": "integer", "format": "int32", "x-aura-field-code": "registryOfficeCountryDivisionId" }, "registryOfficeCountryId": { "type": "integer", "format": "int32", "x-aura-field-code": "registryOfficeCountryId" }, "shortName": { "type": "string", "x-aura-field-code": "shortName" }, "subOrganizationType": { "type": "integer", "format": "int32", "x-aura-field-code": "subOrganizationType" }, "taxOfficeId": { "type": "string", "format": "uuid", "x-aura-field-code": "taxOfficeId" }, "title": { "type": "string", "x-aura-field-code": "title" }, "tradeRegisterNumber": { "type": "string", "x-aura-field-code": "tradeRegisterNumber" } }, "x-aura-field-code": "corporateCustomer" }, "createdDate": { "type": "string", "format": "date-time", "x-aura-field-code": "createdDate" }, "createdOrganizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "createdOrganizationId" }, "customerAttributes": { "type": "array", "items": { "type": "object", "properties": { "attributeKey": { "type": "integer", "format": "int32", "x-aura-field-code": "attributeKey" }, "attributeValue": { "type": "string", "x-aura-field-code": "attributeValue" }, "beginDate": { "type": "string", "format": "date", "x-aura-field-code": "attributeBeginDate" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerAttributeId" }, "isDigital": { "type": "boolean", "x-aura-field-code": "isDigital" } }, "x-aura-field-code": "customerAttributes" } }, "customerAuthorities": { "type": "array", "items": { "type": "object", "properties": { "authorityType": { "type": "integer", "format": "int32", "x-aura-field-code": "authorityType" }, "description": { "type": "string", "x-aura-field-code": "description" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "fromCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "fromCustomerId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerAuthorityId" }, "startDate": { "type": "string", "format": "date-time", "x-aura-field-code": "startDate" }, "toCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "toCustomerId" } }, "x-aura-field-code": "customerAuthorities" } }, "customerChecks": { "type": "array", "items": { "type": "object", "properties": { "changedType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerCheckChangedType" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerCheckId" } }, "x-aura-field-code": "customerChecks" } }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "customerNumber": { "type": "string", "x-aura-field-code": "customerNumber" }, "customerRelationships": { "type": "array", "items": { "type": "object", "properties": { "customerShareholders": { "type": "array", "items": { "type": "object", "properties": { "customerRelationshipId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerRelationshipId" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerShareholderId" }, "shareRate": { "type": "number", "format": "decimal", "x-aura-field-code": "shareRate" }, "startDate": { "type": "string", "format": "date-time", "x-aura-field-code": "startDate" } }, "x-aura-field-code": "customerShareholders" } }, "description": { "type": "string", "x-aura-field-code": "authorityDescription" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "fromCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "fromCustomerId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerRelationshipId" }, "relationType": { "type": "integer", "format": "int32", "x-aura-field-code": "relationType" }, "startDate": { "type": "string", "format": "date-time", "x-aura-field-code": "startDate" }, "toCitizenid": { "type": "string", "x-aura-field-code": "toCitizenid" }, "toCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "toCustomerId" } }, "x-aura-field-code": "customerRelationships" } }, "customerStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "customerStatus" }, "customerSubType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerSubType" }, "customerTaxpayers": { "type": "array", "items": { "type": "object", "properties": { "companyType": { "x-aura-type": "unresolved" }, "countryId": { "type": "integer", "format": "int32", "x-aura-field-code": "countryId" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "description": { "type": "string", "x-aura-field-code": "description" }, "fatcaReason": { "x-aura-type": "unresolved" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "taxpayerId" }, "taxNumber": { "type": "string", "x-aura-field-code": "taxNumber" }, "taxNumberNotReason": { "x-aura-type": "unresolved" }, "taxpayerClass": { "x-aura-type": "unresolved" }, "taxpayerPersonType": { "x-aura-type": "unresolved" }, "taxpayerType": { "type": "integer", "format": "int32", "x-aura-field-code": "taxpayerType" } }, "x-aura-field-code": "customerTaxpayers" } }, "customerType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerType" }, "deathDate": { "type": "string", "format": "date", "x-aura-field-code": "deathDate" }, "emails": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string", "x-aura-field-code": "email" }, "id": { "x-aura-type": "unresolved" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "isVerified": { "type": "boolean", "x-aura-field-code": "isVerified" } }, "x-aura-field-code": "emails" } }, "establishCountryDivisionId": { "type": "integer", "format": "int32", "x-aura-field-code": "establishCountryDivisionId" }, "establishCountryId": { "type": "integer", "format": "int32", "x-aura-field-code": "establishCountryId" }, "establishDate": { "type": "string", "format": "date", "x-aura-field-code": "establishDate" }, "fatherName": { "type": "string", "x-aura-field-code": "fatherName" }, "freeZone": { "type": "integer", "format": "int32", "x-aura-field-code": "freeZone" }, "fullName": { "type": "string", "x-aura-field-code": "fullName" }, "gender": { "type": "integer", "format": "int32", "x-aura-field-code": "gender" }, "givenName": { "type": "string", "x-aura-field-code": "givenName" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "identities": { "type": "array", "items": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "identityCardId" }, "identityDetails": { "type": "array", "items": { "type": "object", "properties": { "fieldValue": { "type": "string", "x-aura-field-code": "fieldValue" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "identityDetails_identityTypeFieldId" }, "identityTypeFieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "identityTypeFieldId" } }, "x-aura-field-code": "identityDetails" } }, "identityTypeId": { "type": "string", "format": "uuid", "x-aura-field-code": "identityTypeId" } }, "x-aura-field-code": "identities" } }, "individualCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "individualCustomerId" }, "isApproved": { "type": "boolean", "x-aura-field-code": "isApproved" }, "isBlackList": { "type": "boolean", "x-aura-field-code": "isBlackList" }, "isCardDeliveryAddress": { "type": "boolean", "x-aura-field-code": "isCardDeliveryAddress" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "isFreeZoneCustomer": { "type": "boolean", "x-aura-field-code": "isFreeZoneCustomer" }, "isPoliticallyExposed": { "type": "boolean", "x-aura-field-code": "isPoliticallyExposed" }, "isSigned": { "type": "boolean", "x-aura-field-code": "isSigned" }, "isVerified": { "type": "boolean", "x-aura-field-code": "isVerified" }, "maidenSurname": { "type": "string", "x-aura-field-code": "maidenSurname" }, "mainOrganizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "mainOrganizationId" }, "maritalStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "maritalStatus" }, "middleName": { "type": "string", "x-aura-field-code": "middleName" }, "motherMaidenSurname": { "type": "string", "x-aura-field-code": "motherMaidenSurname" }, "motherName": { "type": "string", "x-aura-field-code": "motherName" }, "naceId": { "type": "string", "format": "uuid", "x-aura-field-code": "naceId" }, "name": { "type": "string", "x-aura-field-code": "firstName" }, "nationalities": { "type": "array", "items": { "type": "object", "properties": { "countryId": { "type": "integer", "format": "int32", "x-aura-field-code": "countryId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "nationalities_nationalityId" }, "priority": { "type": "integer", "format": "int32", "x-aura-field-code": "priority" } }, "x-aura-field-code": "nationalities" } }, "occupations": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "occupationId" }, "occupationTypeFieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "occupationTypeFieldId" }, "occupationTypeFieldValue": { "type": "string", "x-aura-field-code": "occupationTypeFieldValue" }, "occupationTypeId": { "type": "string", "format": "uuid", "x-aura-field-code": "occupationTypeId" } }, "x-aura-field-code": "occupations" } }, "onboardedDate": { "x-aura-type": "unresolved" }, "onboardedOrganizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "onboardedOrganizationId" }, "organizationType": { "type": "integer", "format": "int32", "x-aura-field-code": "organizationType" }, "phones": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "phoneId" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "isVerified": { "type": "boolean", "x-aura-field-code": "isVerified" }, "phoneNumber": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true }, "phoneType": { "type": "integer", "format": "int32", "x-aura-field-code": "phoneType" } }, "x-aura-field-code": "phones" } }, "profiles": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "profileId" }, "profile": { "type": "integer", "format": "int32", "x-aura-field-code": "profile" } }, "x-aura-field-code": "profiles" } }, "pwfCustomerId": { "type": "integer", "format": "int32", "x-aura-field-code": "pwfCustomerId" }, "recordType": { "type": "integer", "format": "int32", "x-aura-field-code": "recordType" }, "registryOfficeCountryDivisionId": { "type": "integer", "format": "int32", "x-aura-field-code": "registryOfficeCountryDivisionId" }, "registryOfficeCountryId": { "type": "integer", "format": "int32", "x-aura-field-code": "registryOfficeCountryId" }, "residency": { "type": "integer", "format": "int32", "x-aura-field-code": "residency" }, "residentials": { "type": "array", "items": { "type": "object", "properties": { "countryId": { "type": "integer", "format": "int32", "x-aura-field-code": "countryId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "residentialId" }, "priority": { "type": "integer", "format": "int32", "x-aura-field-code": "priority" } }, "x-aura-field-code": "residentials" } }, "segmentName": { "type": "string", "x-aura-field-code": "segmentName" }, "separatorMark": { "type": "string", "x-aura-field-code": "separatorMark" }, "subOrganizationType": { "type": "integer", "format": "int32", "x-aura-field-code": "subOrganizationType" }, "surname": { "type": "string", "x-aura-field-code": "surname", "x-aura-maskable": true }, "transactionId": { "type": "string", "format": "uuid", "x-aura-field-code": "transactionId" }, "unlimitedCompanyCustomer": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "establishedDate": { "type": "string", "format": "date", "x-aura-field-code": "establishedDate" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "unlimitedCompanyCustomerId" }, "taxOfficeId": { "type": "string", "format": "uuid", "x-aura-field-code": "taxOfficeId" }, "title": { "type": "string", "x-aura-field-code": "title" }, "unlimitedCompanyCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "unlimitedCompanyCustomerId" } }, "x-aura-field-code": "unlimitedCompanyCustomer" }, "versionNo": { "type": "integer", "format": "int32", "x-aura-field-code": "versionNo" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-individual-customer-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/customers/individual-customers", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-individual-customer-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/customers/summary": { "get": { "operationId": "aurax-bff-redirect-get-customer-summary-by-id", "tags": [ "customers" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-customer-summary-by-id", "description": "Request and response fields are declared on the routing target `get-customer-summary-by-id`; this entry declares none of its own.\n\nDeclared as Route-bound but absent from the route template, so not sendable: id.", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "addressId": { "type": "string", "format": "uuid", "x-aura-field-code": "addressId" }, "birthDate": { "type": "string", "format": "date", "x-aura-field-code": "birthDate" }, "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "citizenidType": { "type": "integer", "format": "int32", "x-aura-field-code": "citizenidType" }, "customerNumber": { "type": "string", "x-aura-field-code": "customerNumber" }, "customerStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "customerStatus" }, "customerSubType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerSubType" }, "customerType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerType" }, "fullName": { "type": "string", "x-aura-field-code": "fullName" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "isPotential": { "type": "boolean", "x-aura-field-code": "isPotential" }, "mainOrganizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "mainOrganizationId" }, "middleName": { "type": "string", "x-aura-field-code": "middleName" }, "name": { "type": "string", "x-aura-field-code": "name", "x-aura-maskable": true }, "onboardedDate": { "type": "string", "format": "date", "x-aura-field-code": "customerOnboardedDate" }, "profiles": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerProfileId" }, "profile": { "type": "integer", "format": "int32", "x-aura-field-code": "profile" } }, "x-aura-field-code": "customerProfiles" } }, "residency": { "type": "integer", "format": "int32", "x-aura-field-code": "residency" }, "surname": { "type": "string", "x-aura-field-code": "surname", "x-aura-maskable": true } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-customer-summary-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/customers/summary", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/customers/verified/create": { "post": { "operationId": "aurax-bff-service-dynamic-create-verified-customer-bpm-bff", "tags": [ "customers" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-create-verified-customer-bpm-bff", "description": "Request and response fields are declared on the routing target `create-verified-customer-bff`; this entry declares none of its own.", "parameters": [ { "name": "partnerCode", "in": "header", "required": false, "schema": { "type": "string", "x-aura-field-code": "partnerCode" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "consents": { "type": "array", "items": { "type": "object", "x-aura-field-code": "consents" } }, "customerSubType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerSubType" }, "email": { "type": "string", "x-aura-field-code": "email" }, "incomes": { "type": "array", "items": { "type": "object", "properties": { "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "estimatedTransactionVolume": { "type": "number", "format": "decimal", "x-aura-field-code": "estimatedTransactionVolume" }, "monthlyAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "monthlyAmount" }, "sourceOfIncome": { "type": "integer", "format": "int32", "x-aura-field-code": "sourceOfIncome" }, "transactionCount": { "type": "integer", "format": "int32", "x-aura-field-code": "transactionCount" } }, "required": [ "currencyNumber", "monthlyAmount", "sourceOfIncome" ], "x-aura-field-code": "incomes" } }, "kycStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "kycStatus" }, "occupations": { "type": "array", "items": { "type": "object", "x-aura-field-code": "occupations" } }, "phoneNumber": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true }, "workingType": { "type": "integer", "format": "int32", "x-aura-field-code": "occupationWorkingType" } }, "required": [ "citizenid", "customerSubType", "incomes", "phoneNumber" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 9, "claim": 0, "form": 0, "header": 1, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-create-verified-customer-bpm-bff", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/customers/verified/create", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "structure", "declared_type": "CreateVerifiedCustomerDto", "payload": "CreateVerifiedCustomerDto", "collection": false, "members": [ { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerNumber", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/api/customers/{id}/emails/{emailId}": { "post": { "operationId": "aurax-bff-service-dynamic-get-email-address-by-id", "tags": [ "customers" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-get-email-address-by-id", "description": "Request and response fields are declared on the routing target `get-email-address-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" } }, { "name": "emailId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "emailId" } } ], "x-aura-request-binding": { "method": "POST", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 2, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "email": { "type": "string", "x-aura-field-code": "email" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "emailId" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-get-email-address-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/customers/{id}/emails/{emailId}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/customers/{id}/light": { "get": { "operationId": "aurax-bff-service-dynamic-get-light-customer-by-id", "tags": [ "customers" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-get-light-customer-by-id", "description": "Request and response fields are declared on the routing target `get-light-customer-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "boolean", "x-aura-field-code": "include" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 1 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "addressId": { "type": "string", "format": "uuid", "x-aura-field-code": "addressId" }, "birthCountryId": { "type": "integer", "format": "int32", "x-aura-field-code": "birthCountryId" }, "birthDate": { "type": "string", "format": "date", "x-aura-field-code": "birthDate" }, "birthPlace": { "type": "string", "x-aura-field-code": "birthPlace" }, "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "citizenidType": { "type": "integer", "format": "int32", "x-aura-field-code": "citizenidType" }, "closeDate": { "type": "string", "format": "date", "x-aura-field-code": "closeDate" }, "closedDate": { "type": "string", "format": "date", "x-aura-field-code": "closedDate" }, "closedReason": { "type": "integer", "format": "int32", "x-aura-field-code": "closedReason" }, "corporateCustomer": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "establishCountryDivisionId": { "type": "integer", "format": "int32", "x-aura-field-code": "establishCountryDivisionId" }, "establishCountryId": { "type": "integer", "format": "int32", "x-aura-field-code": "establishCountryId" }, "establishDate": { "type": "string", "format": "date", "x-aura-field-code": "establishDate" }, "freeZone": { "type": "integer", "format": "int32", "x-aura-field-code": "freeZone" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateCustomerId" }, "isFreeZoneCustomer": { "type": "boolean", "x-aura-field-code": "isFreeZoneCustomer" }, "legalOrganizationType": { "type": "integer", "format": "int32", "x-aura-field-code": "legalOrganizationType" }, "naceId": { "type": "string", "format": "uuid", "x-aura-field-code": "naceId" }, "organizationType": { "type": "integer", "format": "int32", "x-aura-field-code": "organizationType" }, "registryOfficeCountryDivisionId": { "type": "integer", "format": "int32", "x-aura-field-code": "registryOfficeCountryDivisionId" }, "registryOfficeCountryId": { "type": "integer", "format": "int32", "x-aura-field-code": "registryOfficeCountryId" }, "shortName": { "type": "string", "x-aura-field-code": "shortName" }, "subOrganizationType": { "type": "integer", "format": "int32", "x-aura-field-code": "subOrganizationType" }, "taxOfficeId": { "type": "string", "format": "uuid", "x-aura-field-code": "taxOfficeId" }, "title": { "type": "string", "x-aura-field-code": "title" }, "tradeRegisterNumber": { "type": "string", "x-aura-field-code": "tradeRegisterNumber" } }, "x-aura-field-code": "corporateCustomer" }, "createdDate": { "type": "string", "format": "date-time", "x-aura-field-code": "customer_createdDate" }, "createdOrganizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "createdOrganizationId" }, "customerNumber": { "type": "string", "x-aura-field-code": "customerNumber" }, "customerStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "customerStatus" }, "customerSubType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerSubType" }, "customerType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerType" }, "deathDate": { "type": "string", "format": "date", "x-aura-field-code": "deathDate" }, "emails": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string", "x-aura-field-code": "email" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "emailId" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "isVerified": { "type": "boolean", "x-aura-field-code": "isVerified" } }, "x-aura-field-code": "emails" } }, "fatherName": { "type": "string", "x-aura-field-code": "fatherName" }, "freeZone": { "type": "integer", "format": "int32", "x-aura-field-code": "freeZone" }, "fullName": { "type": "string", "x-aura-field-code": "fullName" }, "gender": { "type": "integer", "format": "int32", "x-aura-field-code": "gender" }, "givenName": { "type": "string", "x-aura-field-code": "givenName" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "individualCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "individualCustomerId" }, "isBlackList": { "type": "boolean", "x-aura-field-code": "isBlackList" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "isFreeZoneCustomer": { "type": "boolean", "x-aura-field-code": "isFreeZoneCustomer" }, "isPoliticallyExposed": { "type": "boolean", "x-aura-field-code": "isPoliticallyExposed" }, "languageId": { "type": "string", "format": "uuid", "x-aura-field-code": "languageId" }, "maidenSurname": { "type": "string", "x-aura-field-code": "maidenSurname" }, "mainOrganizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "mainOrganizationId" }, "maritalStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "maritalStatus" }, "middleName": { "type": "string", "x-aura-field-code": "middleName" }, "motherMaidenSurname": { "type": "string", "x-aura-field-code": "motherMaidenSurname" }, "motherName": { "type": "string", "x-aura-field-code": "motherName" }, "naceId": { "type": "string", "format": "uuid", "x-aura-field-code": "naceId" }, "name": { "type": "string", "x-aura-field-code": "firstName" }, "onboardedDate": { "type": "string", "format": "date", "x-aura-field-code": "customerOnboardedDate" }, "onboardedOrganizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "onboardedOrganizationId" }, "organizationType": { "type": "integer", "format": "int32", "x-aura-field-code": "organizationType" }, "phones": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "phoneId" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "isVerified": { "type": "boolean", "x-aura-field-code": "isVerified" }, "phoneNumber": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true }, "phoneType": { "type": "integer", "format": "int32", "x-aura-field-code": "phoneType" } }, "x-aura-field-code": "phones" } }, "profiles": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerProfileId" }, "profile": { "type": "integer", "format": "int32", "x-aura-field-code": "profile" } }, "x-aura-field-code": "profiles" } }, "recordType": { "type": "integer", "format": "int32", "x-aura-field-code": "recordType" }, "registryOfficeCountryDivisionId": { "type": "integer", "format": "int32", "x-aura-field-code": "registryOfficeCountryDivisionId" }, "registryOfficeCountryId": { "type": "integer", "format": "int32", "x-aura-field-code": "registryOfficeCountryId" }, "residency": { "type": "integer", "format": "int32", "x-aura-field-code": "residency" }, "subOrganizationType": { "type": "integer", "format": "int32", "x-aura-field-code": "subOrganizationType" }, "surname": { "type": "string", "x-aura-field-code": "surname", "x-aura-maskable": true }, "transactionid": { "type": "string", "format": "uuid", "x-aura-field-code": "vendorTransactionid" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "addressId": { "type": "string", "format": "uuid", "x-aura-field-code": "addressId" }, "birthCountryId": { "type": "integer", "format": "int32", "x-aura-field-code": "birthCountryId" }, "birthDate": { "type": "string", "format": "date", "x-aura-field-code": "birthDate" }, "birthPlace": { "type": "string", "x-aura-field-code": "birthPlace" }, "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "citizenidType": { "type": "integer", "format": "int32", "x-aura-field-code": "citizenidType" }, "closeDate": { "type": "string", "format": "date", "x-aura-field-code": "closeDate" }, "closedDate": { "type": "string", "format": "date", "x-aura-field-code": "closedDate" }, "closedReason": { "type": "integer", "format": "int32", "x-aura-field-code": "closedReason" }, "corporateCustomer": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "establishCountryDivisionId": { "type": "integer", "format": "int32", "x-aura-field-code": "establishCountryDivisionId" }, "establishCountryId": { "type": "integer", "format": "int32", "x-aura-field-code": "establishCountryId" }, "establishDate": { "type": "string", "format": "date", "x-aura-field-code": "establishDate" }, "freeZone": { "type": "integer", "format": "int32", "x-aura-field-code": "freeZone" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateCustomerId" }, "isFreeZoneCustomer": { "type": "boolean", "x-aura-field-code": "isFreeZoneCustomer" }, "legalOrganizationType": { "type": "integer", "format": "int32", "x-aura-field-code": "legalOrganizationType" }, "naceId": { "type": "string", "format": "uuid", "x-aura-field-code": "naceId" }, "organizationType": { "type": "integer", "format": "int32", "x-aura-field-code": "organizationType" }, "registryOfficeCountryDivisionId": { "type": "integer", "format": "int32", "x-aura-field-code": "registryOfficeCountryDivisionId" }, "registryOfficeCountryId": { "type": "integer", "format": "int32", "x-aura-field-code": "registryOfficeCountryId" }, "shortName": { "type": "string", "x-aura-field-code": "shortName" }, "subOrganizationType": { "type": "integer", "format": "int32", "x-aura-field-code": "subOrganizationType" }, "taxOfficeId": { "type": "string", "format": "uuid", "x-aura-field-code": "taxOfficeId" }, "title": { "type": "string", "x-aura-field-code": "title" }, "tradeRegisterNumber": { "type": "string", "x-aura-field-code": "tradeRegisterNumber" } }, "x-aura-field-code": "corporateCustomer" }, "createdDate": { "type": "string", "format": "date-time", "x-aura-field-code": "customer_createdDate" }, "createdOrganizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "createdOrganizationId" }, "customerNumber": { "type": "string", "x-aura-field-code": "customerNumber" }, "customerStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "customerStatus" }, "customerSubType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerSubType" }, "customerType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerType" }, "deathDate": { "type": "string", "format": "date", "x-aura-field-code": "deathDate" }, "emails": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string", "x-aura-field-code": "email" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "emailId" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "isVerified": { "type": "boolean", "x-aura-field-code": "isVerified" } }, "x-aura-field-code": "emails" } }, "fatherName": { "type": "string", "x-aura-field-code": "fatherName" }, "freeZone": { "type": "integer", "format": "int32", "x-aura-field-code": "freeZone" }, "fullName": { "type": "string", "x-aura-field-code": "fullName" }, "gender": { "type": "integer", "format": "int32", "x-aura-field-code": "gender" }, "givenName": { "type": "string", "x-aura-field-code": "givenName" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "individualCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "individualCustomerId" }, "isBlackList": { "type": "boolean", "x-aura-field-code": "isBlackList" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "isFreeZoneCustomer": { "type": "boolean", "x-aura-field-code": "isFreeZoneCustomer" }, "isPoliticallyExposed": { "type": "boolean", "x-aura-field-code": "isPoliticallyExposed" }, "languageId": { "type": "string", "format": "uuid", "x-aura-field-code": "languageId" }, "maidenSurname": { "type": "string", "x-aura-field-code": "maidenSurname" }, "mainOrganizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "mainOrganizationId" }, "maritalStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "maritalStatus" }, "middleName": { "type": "string", "x-aura-field-code": "middleName" }, "motherMaidenSurname": { "type": "string", "x-aura-field-code": "motherMaidenSurname" }, "motherName": { "type": "string", "x-aura-field-code": "motherName" }, "naceId": { "type": "string", "format": "uuid", "x-aura-field-code": "naceId" }, "name": { "type": "string", "x-aura-field-code": "firstName" }, "onboardedDate": { "type": "string", "format": "date", "x-aura-field-code": "customerOnboardedDate" }, "onboardedOrganizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "onboardedOrganizationId" }, "organizationType": { "type": "integer", "format": "int32", "x-aura-field-code": "organizationType" }, "phones": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "phoneId" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "isVerified": { "type": "boolean", "x-aura-field-code": "isVerified" }, "phoneNumber": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true }, "phoneType": { "type": "integer", "format": "int32", "x-aura-field-code": "phoneType" } }, "x-aura-field-code": "phones" } }, "profiles": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerProfileId" }, "profile": { "type": "integer", "format": "int32", "x-aura-field-code": "profile" } }, "x-aura-field-code": "profiles" } }, "recordType": { "type": "integer", "format": "int32", "x-aura-field-code": "recordType" }, "registryOfficeCountryDivisionId": { "type": "integer", "format": "int32", "x-aura-field-code": "registryOfficeCountryDivisionId" }, "registryOfficeCountryId": { "type": "integer", "format": "int32", "x-aura-field-code": "registryOfficeCountryId" }, "residency": { "type": "integer", "format": "int32", "x-aura-field-code": "residency" }, "subOrganizationType": { "type": "integer", "format": "int32", "x-aura-field-code": "subOrganizationType" }, "surname": { "type": "string", "x-aura-field-code": "surname", "x-aura-maskable": true }, "transactionid": { "type": "string", "format": "uuid", "x-aura-field-code": "vendorTransactionid" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "addressId": { "type": "string", "format": "uuid", "x-aura-field-code": "addressId" }, "birthCountryId": { "type": "integer", "format": "int32", "x-aura-field-code": "birthCountryId" }, "birthDate": { "type": "string", "format": "date", "x-aura-field-code": "birthDate" }, "birthPlace": { "type": "string", "x-aura-field-code": "birthPlace" }, "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "citizenidType": { "type": "integer", "format": "int32", "x-aura-field-code": "citizenidType" }, "closeDate": { "type": "string", "format": "date", "x-aura-field-code": "closeDate" }, "closedDate": { "type": "string", "format": "date", "x-aura-field-code": "closedDate" }, "closedReason": { "type": "integer", "format": "int32", "x-aura-field-code": "closedReason" }, "corporateCustomer": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "establishCountryDivisionId": { "type": "integer", "format": "int32", "x-aura-field-code": "establishCountryDivisionId" }, "establishCountryId": { "type": "integer", "format": "int32", "x-aura-field-code": "establishCountryId" }, "establishDate": { "type": "string", "format": "date", "x-aura-field-code": "establishDate" }, "freeZone": { "type": "integer", "format": "int32", "x-aura-field-code": "freeZone" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateCustomerId" }, "isFreeZoneCustomer": { "type": "boolean", "x-aura-field-code": "isFreeZoneCustomer" }, "legalOrganizationType": { "type": "integer", "format": "int32", "x-aura-field-code": "legalOrganizationType" }, "naceId": { "type": "string", "format": "uuid", "x-aura-field-code": "naceId" }, "organizationType": { "type": "integer", "format": "int32", "x-aura-field-code": "organizationType" }, "registryOfficeCountryDivisionId": { "type": "integer", "format": "int32", "x-aura-field-code": "registryOfficeCountryDivisionId" }, "registryOfficeCountryId": { "type": "integer", "format": "int32", "x-aura-field-code": "registryOfficeCountryId" }, "shortName": { "type": "string", "x-aura-field-code": "shortName" }, "subOrganizationType": { "type": "integer", "format": "int32", "x-aura-field-code": "subOrganizationType" }, "taxOfficeId": { "type": "string", "format": "uuid", "x-aura-field-code": "taxOfficeId" }, "title": { "type": "string", "x-aura-field-code": "title" }, "tradeRegisterNumber": { "type": "string", "x-aura-field-code": "tradeRegisterNumber" } }, "x-aura-field-code": "corporateCustomer" }, "createdDate": { "type": "string", "format": "date-time", "x-aura-field-code": "customer_createdDate" }, "createdOrganizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "createdOrganizationId" }, "customerNumber": { "type": "string", "x-aura-field-code": "customerNumber" }, "customerStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "customerStatus" }, "customerSubType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerSubType" }, "customerType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerType" }, "deathDate": { "type": "string", "format": "date", "x-aura-field-code": "deathDate" }, "emails": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string", "x-aura-field-code": "email" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "emailId" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "isVerified": { "type": "boolean", "x-aura-field-code": "isVerified" } }, "x-aura-field-code": "emails" } }, "fatherName": { "type": "string", "x-aura-field-code": "fatherName" }, "freeZone": { "type": "integer", "format": "int32", "x-aura-field-code": "freeZone" }, "fullName": { "type": "string", "x-aura-field-code": "fullName" }, "gender": { "type": "integer", "format": "int32", "x-aura-field-code": "gender" }, "givenName": { "type": "string", "x-aura-field-code": "givenName" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "individualCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "individualCustomerId" }, "isBlackList": { "type": "boolean", "x-aura-field-code": "isBlackList" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "isFreeZoneCustomer": { "type": "boolean", "x-aura-field-code": "isFreeZoneCustomer" }, "isPoliticallyExposed": { "type": "boolean", "x-aura-field-code": "isPoliticallyExposed" }, "languageId": { "type": "string", "format": "uuid", "x-aura-field-code": "languageId" }, "maidenSurname": { "type": "string", "x-aura-field-code": "maidenSurname" }, "mainOrganizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "mainOrganizationId" }, "maritalStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "maritalStatus" }, "middleName": { "type": "string", "x-aura-field-code": "middleName" }, "motherMaidenSurname": { "type": "string", "x-aura-field-code": "motherMaidenSurname" }, "motherName": { "type": "string", "x-aura-field-code": "motherName" }, "naceId": { "type": "string", "format": "uuid", "x-aura-field-code": "naceId" }, "name": { "type": "string", "x-aura-field-code": "firstName" }, "onboardedDate": { "type": "string", "format": "date", "x-aura-field-code": "customerOnboardedDate" }, "onboardedOrganizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "onboardedOrganizationId" }, "organizationType": { "type": "integer", "format": "int32", "x-aura-field-code": "organizationType" }, "phones": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "phoneId" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "isVerified": { "type": "boolean", "x-aura-field-code": "isVerified" }, "phoneNumber": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true }, "phoneType": { "type": "integer", "format": "int32", "x-aura-field-code": "phoneType" } }, "x-aura-field-code": "phones" } }, "profiles": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerProfileId" }, "profile": { "type": "integer", "format": "int32", "x-aura-field-code": "profile" } }, "x-aura-field-code": "profiles" } }, "recordType": { "type": "integer", "format": "int32", "x-aura-field-code": "recordType" }, "registryOfficeCountryDivisionId": { "type": "integer", "format": "int32", "x-aura-field-code": "registryOfficeCountryDivisionId" }, "registryOfficeCountryId": { "type": "integer", "format": "int32", "x-aura-field-code": "registryOfficeCountryId" }, "residency": { "type": "integer", "format": "int32", "x-aura-field-code": "residency" }, "subOrganizationType": { "type": "integer", "format": "int32", "x-aura-field-code": "subOrganizationType" }, "surname": { "type": "string", "x-aura-field-code": "surname", "x-aura-maskable": true }, "transactionid": { "type": "string", "format": "uuid", "x-aura-field-code": "vendorTransactionid" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-get-light-customer-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/customers/{id}/light", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/customers/{id}/phones/{phoneId}": { "post": { "operationId": "aurax-bff-service-dynamic-get-phone-by-id", "tags": [ "customers" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-get-phone-by-id", "description": "Request and response fields are declared on the routing target `get-phone-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" } }, { "name": "phoneId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "phoneId" } } ], "x-aura-request-binding": { "method": "POST", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 2, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "phoneId" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "phoneNumber": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true }, "phoneType": { "type": "integer", "format": "int32", "x-aura-field-code": "phoneType" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-get-phone-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/customers/{id}/phones/{phoneId}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/customers/{id}/status": { "post": { "operationId": "aurax-bff-service-dynamic-change-customer-status", "tags": [ "customers" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-change-customer-status", "description": "Request and response fields are declared on the routing target `change-customer-status`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "closedReason": { "type": "integer", "format": "int32", "x-aura-field-code": "closedReason" }, "customerStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "customerStatus" } }, "required": [ "customerStatus" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 2, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-change-customer-status", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/customers/{id}/status", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/deploy-process-definitions-by-ids": { "post": { "operationId": "aurax-bff-service-dynamic-deploy-process-definitions-by-ids", "tags": [ "deploy-process-definitions-by-ids" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "deploy process definitions by ids", "description": "Invokes the `aurax-bff-service-dynamic-deploy-process-definitions-by-ids` service definition through `POST /api/deploy-process-definitions-by-ids`.\n\nRequest and response fields are declared on the routing target `deploy-process-definitions-by-ids`; this entry declares none of its own.", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-deploy-process-definitions-by-ids", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/deploy-process-definitions-by-ids", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/deploy-process-definitions-by-ui": { "post": { "operationId": "aurax-bff-service-dynamic-deploy-process-definitions-by-ui", "tags": [ "deploy-process-definitions-by-ui" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-deploy-process-definitions-by-ui", "description": "Request and response fields are declared on the routing target `deploy-process-definitions-by-ui`; this entry declares none of its own.", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-deploy-process-definitions-by-ui", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/deploy-process-definitions-by-ui", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/email-notifications/send": { "post": { "operationId": "aurax-bff-service-dynamic-send-email", "tags": [ "email-notifications" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-send-email", "description": "Request and response fields are declared on the routing target `send-email`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "attachments": { "type": "array", "items": { "type": "object", "properties": { "base64Content": { "type": "string", "x-aura-field-code": "base64Content" }, "filename": { "type": "string", "x-aura-field-code": "filename" } }, "required": [ "base64Content", "filename" ], "x-aura-field-code": "attachments" } }, "bcc": { "type": "array", "items": { "type": "string", "x-aura-field-code": "bcc" } }, "body": { "type": "string", "x-aura-field-code": "email_body" }, "cC": { "type": "array", "items": { "type": "string", "x-aura-field-code": "cC" } }, "isBodyHtml": { "type": "boolean", "x-aura-field-code": "isBodyHtml" }, "subject": { "type": "string", "x-aura-field-code": "subject" }, "to": { "type": "array", "items": { "type": "string", "x-aura-field-code": "to" } } }, "required": [ "body", "subject", "to" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 7, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-send-email", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/email-notifications/send", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "declared_type": "Unit", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "payload": "Unit" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_EMAIL_1", "status": 400, "message": null, "message_available": false, "constant_name": "EMAIL_TO_REQUIRED" }, { "code": "ERR_EMAIL_2", "status": 400, "message": null, "message_available": false, "constant_name": "EMAIL_SUBJECT_REQUIRED" }, { "code": "ERR_EMAIL_3", "status": 400, "message": null, "message_available": false, "constant_name": "EMAIL_BODY_REQUIRED" }, { "code": "ERR_EMAIL_4", "status": 400, "message": null, "message_available": false, "constant_name": "EMAIL_FILEXT_REQUIRED" }, { "code": "ERR_EMAIL_7", "status": 400, "message": null, "message_available": false, "constant_name": "EMAIL_FILENAME_REQUIRED" } ] } } }, "/api/external-services": { "post": { "operationId": "aurax-bff-redirect-create-external-service-definition", "tags": [ "external-services" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-create-external-service-definition", "description": "Request and response fields are declared on the routing target `create-external-service-definition`; this entry declares none of its own.\n\nFields with no binding_source in the catalog, so their position on the request is undocumented: id.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "authData": { "type": "string", "x-aura-field-code": "authData", "x-aura-maskable": true }, "authExpirePeriod": { "type": "integer", "format": "int32", "x-aura-field-code": "authExpirePeriod" }, "authType": { "type": "integer", "format": "int32", "x-aura-field-code": "authType", "x-aura-parameter-enumeration": { "state": "resolved", "parameter": "auth_type", "values": [ { "value": 1, "name": "Basic" }, { "value": 2, "name": "xyz" } ] } }, "serviceDefinitionId": { "type": "string", "format": "uuid", "x-aura-field-code": "serviceDefinitionId" }, "timeoutDuration": { "type": "integer", "format": "int64", "x-aura-field-code": "timeoutDuration" }, "url": { "type": "string", "x-aura-field-code": "url" } }, "required": [ "authData", "authExpirePeriod", "authType", "serviceDefinitionId", "url" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 6, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-external-service-definition", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/external-services", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "structure", "declared_type": "AuraCommandDto", "payload": "AuraCommandDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_INTGRTN_33", "status": 400, "message": { "ar": "يجب أن يكون تعريف الخدمة الخارجية فريدًا", "en": "External service definition must be unique", "tr": "Dış servis tanımı benzersiz olmalıdır" }, "message_available": true, "constant_name": "EXTERNAL_SERVICE_DEFINITION_MUST_BE_UNIQUE" } ] } } }, "/api/external-services/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-external-service-definition", "tags": [ "external-services" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-delete-external-service-definition", "description": "Request and response fields are declared on the routing target `delete-external-service-definition`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "externalServiceDefinitionId" } } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-external-service-definition", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/external-services/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_INTGRTN_26", "status": 400, "message": { "ar": "تعريف الخدمة غير موجود", "en": "Service definition cannot be found", "tr": "servis tanımı bulunamadı" }, "message_available": true, "constant_name": "EXTERNAL_SERVICE_DEFINITION_NOT_FOUND" } ] } } }, "/api/get-customer-info-by-citizenid": { "get": { "operationId": "aurax-bff-redirect-get-customer-info-by-citizenid", "tags": [ "get-customer-info-by-citizenid" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "Get Customer Info By Citizenid", "description": "Invokes the `aurax-bff-redirect-get-customer-info-by-citizenid` service definition through `GET /api/get-customer-info-by-citizenid`.\n\nRequest and response fields are declared on the routing target `get-customer-info-by-citizenid`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "customerNumber": { "type": "string", "x-aura-field-code": "customerNumber" } }, "required": [ "citizenid" ] } } }, "description": "The catalog declares Body-bound fields on this GET operation. Request bodies on GET have no defined semantics in HTTP; this documents the catalog, not a recommendation. Not every field below is accepted: the platform selects which of them this operation admits and drops the rest. Of the fields below, the binder does not admit `citizenid`, which this document nevertheless marks required because the catalog declares it so.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 2, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [ "body" ], "dropped_field_names": { "body": [ "citizenid", "customerNumber" ] }, "dropped_mandatory_field_names": [ "citizenid" ], "verdict": "declared-fields-not-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": "The HTTP edge in front of this operation comes in two shapes and they differ: the platform's typed route readers bind GET and DELETE from the URL and never read a body, while its untyped catalog-redirect reader collects the body whenever the request carries one. It does not change the answer above: the selection below happens after the edge, and excludes these fields either way." }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "customerNumber": { "type": "string", "x-aura-field-code": "customerNumber" }, "email": { "type": "string", "x-aura-field-code": "email" }, "name": { "type": "string", "x-aura-field-code": "firstName" }, "phoneNumber": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true }, "surName": { "type": "string", "x-aura-field-code": "surname", "x-aura-maskable": true } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "customerNumber": { "type": "string", "x-aura-field-code": "customerNumber" }, "email": { "type": "string", "x-aura-field-code": "email" }, "name": { "type": "string", "x-aura-field-code": "firstName" }, "phoneNumber": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true }, "surName": { "type": "string", "x-aura-field-code": "surname", "x-aura-maskable": true } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "customerNumber": { "type": "string", "x-aura-field-code": "customerNumber" }, "email": { "type": "string", "x-aura-field-code": "email" }, "name": { "type": "string", "x-aura-field-code": "firstName" }, "phoneNumber": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true }, "surName": { "type": "string", "x-aura-field-code": "surname", "x-aura-maskable": true } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-customer-info-by-citizenid", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/get-customer-info-by-citizenid", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/loan-collection/check-customer-debt": { "get": { "operationId": "aurax-bff-service-dynamic-check-customer-debt", "tags": [ "loan-collection" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-check-customer-debt", "description": "Request and response fields are declared on the routing target `check-customer-debt`; this entry declares none of its own.", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "isCustomerDebtExists": { "type": "boolean", "x-aura-field-code": "isCustomerDebtExists" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-check-customer-debt", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/loan-collection/check-customer-debt", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/loan/by-customer-id/{customerId}": { "get": { "operationId": "aurax-bff-service-dynamic-get-loan-list-by-customer-id", "tags": [ "loan" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-get-loan-list-by-customer-id", "description": "Request and response fields are declared on the routing target `get-loan-list-by-customer-id`; this entry declares none of its own.", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" } }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "accountingEntryId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryId" }, "accrualStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "accrualStatus" }, "allotmentQueryId": { "type": "string", "format": "uuid", "x-aura-field-code": "allotmentQueryId" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "loanAmount" }, "cancelDate": { "type": "string", "format": "date-time", "x-aura-field-code": "cancelDate" }, "cancelDescription": { "type": "string", "x-aura-field-code": "cancelDescription" }, "cancelReason": { "type": "string", "x-aura-field-code": "cancelReason" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "customerAccountId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerAccountId" }, "customerApplicationId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerApplicationId" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "customerRiskId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerRiskId" }, "earlyPaymentDiscountRate": { "type": "number", "format": "decimal", "x-aura-field-code": "earlyPaymentDiscountRate" }, "exchangeRate": { "type": "number", "format": "decimal", "x-aura-field-code": "loanExchangeRate" }, "fundingSource": { "type": "integer", "format": "int32", "x-aura-field-code": "fundingSource" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "loanId" }, "latePenaltyRate": { "type": "number", "format": "decimal", "x-aura-field-code": "latePenaltyRate" }, "loanCloseDate": { "type": "string", "format": "date-time", "x-aura-field-code": "loanCloseDate" }, "loanCloseType": { "type": "integer", "format": "int32", "x-aura-field-code": "loanCloseType" }, "loanDate": { "type": "string", "format": "date-time", "x-aura-field-code": "loanDate" }, "loanNumber": { "type": "string", "x-aura-field-code": "loanNumber" }, "loanProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanProductId" }, "organizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "organizationId" }, "parentLoanId": { "type": "string", "format": "uuid", "x-aura-field-code": "parentLoanId" }, "proposalId": { "type": "string", "format": "uuid", "x-aura-field-code": "proposalId" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "loanStatus" }, "statusContext": { "type": "string", "x-aura-field-code": "loanStatusContext" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-get-loan-list-by-customer-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/loan/by-customer-id/{customerId}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-loan-list-by-customer-id`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "LoanDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CustomerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ProposalId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CustomerApplicationId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CustomerAccountId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "LoanProductId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "LoanNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FundingSource", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "OrganizationId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Amount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "LoanDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "Status", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ExchangeRate", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "AccountingEntryId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "LoanCloseDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "LoanCloseType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CustomerRiskId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "AllotmentQueryId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ParentLoanId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CancelDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "CancelReason", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CancelDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LatePenaltyRate", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "EarlyPaymentDiscountRate", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "AccrualStatus", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ExternalReference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExternalTransactionid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "VendorExternalId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "StatusContext", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PartnerId", "declared_type": "Guid?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/api/loan/cancel-by-external-reference": { "post": { "operationId": "aurax-bff-service-dynamic-cancel-loan-by-external-reference-bpmn", "tags": [ "loan" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-cancel-loan-by-external-reference-bpmn", "description": "Request and response fields are declared on the routing target `cancel-loan-by-external-reference-bff`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "externalReference": { "type": "string", "x-aura-field-code": "externalReference" }, "loanCancelDescription": { "type": "string", "x-aura-field-code": "loanCancelDescription" }, "loanCancelReason": { "type": "integer", "format": "int32", "x-aura-field-code": "loanCancelReason" } }, "required": [ "externalReference", "loanCancelDescription", "loanCancelReason" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 3, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-cancel-loan-by-external-reference-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/loan/cancel-by-external-reference", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "structure", "declared_type": "CancelLoanByExternalReferenceDto", "payload": "CancelLoanByExternalReferenceDto", "collection": false, "members": [ { "name": "resultCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "resultMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "localTransactionAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "localTransactionCurrency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "localFeeAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "localFeeCurrency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "feeAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "feeCurrency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "feeTrnCodeMatrixId", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/api/loan/cancel-by-external-reference-bpmn": { "post": { "operationId": "aurax-bff-service-dynamic-cancel-loan-by-external-reference-bpm", "tags": [ "loan" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-cancel-loan-by-external-reference-bpm", "description": "Request and response fields are declared on the routing target `cancel-loan-by-external-reference-bpmn`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "externalReference": { "type": "string", "x-aura-field-code": "externalReference" }, "loanCancelDescription": { "type": "string", "x-aura-field-code": "loanCancelDescription" }, "loanCancelReason": { "type": "integer", "format": "int32", "x-aura-field-code": "loanCancelReason" } }, "required": [ "externalReference", "loanCancelDescription", "loanCancelReason" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 3, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-cancel-loan-by-external-reference-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/loan/cancel-by-external-reference-bpmn", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/loan/create-bank-loan-collection-bpmn": { "post": { "operationId": "aurax-bff-service-dynamic-create-bank-loan-collection-bpmn", "tags": [ "loan" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-create-bank-loan-collection-bpmn", "description": "Request and response fields are declared on the routing target `create-bank-loan-collection-bpmn`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "installments": { "type": "array", "items": { "type": "object", "properties": { "installmentAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "installmentAmount" }, "installmentId": { "type": "string", "format": "uuid", "x-aura-field-code": "installmentId" } }, "required": [ "installmentAmount", "installmentId" ], "x-aura-field-code": "installments" } } }, "required": [ "installments" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "collectionList": { "type": "array", "items": { "type": "object", "x-aura-field-code": "collectionList" } } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "collectionList": { "type": "array", "items": { "type": "object", "x-aura-field-code": "collectionList" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "collectionList": { "type": "array", "items": { "type": "object", "x-aura-field-code": "collectionList" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-create-bank-loan-collection-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/loan/create-bank-loan-collection-bpmn", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/loan/create-payment-loan-test-bpmn": { "post": { "operationId": "aurax-bff-service-dynamic-create-payment-loan-test-bpmn", "tags": [ "loan" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-create-payment-loan-test-bpmn", "description": "Request and response fields are declared on the routing target `create-payment-loan-test-bpmn`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "firstInstallmentDate": { "type": "string", "format": "date-time", "x-aura-field-code": "firstInstallmentDate" }, "installmentCount": { "type": "integer", "format": "int32", "x-aura-field-code": "installmentCount" }, "loanProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanProductId" } }, "required": [ "amount", "currencyNumber", "customerId", "firstInstallmentDate", "installmentCount", "loanProductId" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 6, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "loanId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanId" }, "loanNumber": { "type": "string", "x-aura-field-code": "loanNumber" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "loanId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanId" }, "loanNumber": { "type": "string", "x-aura-field-code": "loanNumber" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "loanId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanId" }, "loanNumber": { "type": "string", "x-aura-field-code": "loanNumber" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-create-payment-loan-test-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/loan/create-payment-loan-test-bpmn", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/loan/customer-total-debt-bpmn": { "post": { "operationId": "aurax-bff-service-dynamic-calculate-customer-current-total-loan-debt-bpmn", "tags": [ "loan" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-calculate-customer-current-total-loan-debt-bpmn", "description": "Request and response fields are declared on the routing target `calculate-customer-current-total-loan-debt-bpmn`; this entry declares none of its own.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "loanId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanId" } } } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 2, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "loans": { "type": "array", "items": { "type": "object", "x-aura-field-code": "loans" } }, "totalEarlyRepaymentAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "totalEarlyRepaymentAmount" }, "totalPreviousRemainingLoanAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "totalPreviousRemainingLoanAmount" }, "totalRemainingLoanAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "totalRemainingLoanAmount" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "loans": { "type": "array", "items": { "type": "object", "x-aura-field-code": "loans" } }, "totalEarlyRepaymentAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "totalEarlyRepaymentAmount" }, "totalPreviousRemainingLoanAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "totalPreviousRemainingLoanAmount" }, "totalRemainingLoanAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "totalRemainingLoanAmount" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "loans": { "type": "array", "items": { "type": "object", "x-aura-field-code": "loans" } }, "totalEarlyRepaymentAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "totalEarlyRepaymentAmount" }, "totalPreviousRemainingLoanAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "totalPreviousRemainingLoanAmount" }, "totalRemainingLoanAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "totalRemainingLoanAmount" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-calculate-customer-current-total-loan-debt-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/loan/customer-total-debt-bpmn", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/loan/external-firm/calculate-first-installment-date-list": { "post": { "operationId": "aurax-bff-service-dynamic-calculate-first-installment-date-list", "tags": [ "loan" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-calculate-first-installment-date-list", "description": "Request and response fields are declared on the routing target `calculate-first-installment-date-list`; this entry declares none of its own.\n\nRead from the caller's token, not from the request: customerId.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "firstInstallmentDate": { "type": "string", "format": "date-time", "x-aura-field-code": "firstInstallmentDate" } } } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 1, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-calculate-first-installment-date-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/loan/external-firm/calculate-first-installment-date-list", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "structure", "declared_type": "CalculateFirstInstallmentDateListDto", "payload": "CalculateFirstInstallmentDateListDto", "collection": false, "members": [ { "name": "calculatedInstallmentDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "AvailableDayOptions", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/api/loan/external-firm/calculate-payback-plan": { "post": { "operationId": "aurax-bff-service-dynamic-calculate-payback-plan-external-firm-bpmn", "tags": [ "loan" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-calculate-payback-plan-external-firm-bpmn", "description": "Request and response fields are declared on the routing target `calculate-payback-plan-external-firm-bpmn`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "firstInstallmentDate": { "type": "string", "format": "date-time", "x-aura-field-code": "firstInstallmentDate" }, "installmentCount": { "type": "integer", "format": "int32", "x-aura-field-code": "installmentCount" }, "itemsInBasket": { "type": "array", "items": { "type": "object", "x-aura-field-code": "itemsInBasket" } } }, "required": [ "firstInstallmentDate", "itemsInBasket" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 4, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "averageMaturity": { "type": "integer", "format": "int32", "x-aura-field-code": "averageMaturity" }, "dayDifferentInstallment": { "type": "string", "x-aura-field-code": "dayDifferentInstallment" }, "dayInYearCount": { "type": "string", "x-aura-field-code": "dayInYearCount" }, "loanProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanProductId" }, "paybackPlanList": { "type": "array", "items": { "type": "object", "x-aura-field-code": "paybackPlanList" } }, "paybackPlanMethod": { "type": "integer", "format": "int32", "x-aura-field-code": "paybackPlanMethod" }, "productTaxListOutput": { "type": "array", "items": { "type": "object", "x-aura-field-code": "productTaxListOutput" } } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "averageMaturity": { "type": "integer", "format": "int32", "x-aura-field-code": "averageMaturity" }, "dayDifferentInstallment": { "type": "string", "x-aura-field-code": "dayDifferentInstallment" }, "dayInYearCount": { "type": "string", "x-aura-field-code": "dayInYearCount" }, "loanProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanProductId" }, "paybackPlanList": { "type": "array", "items": { "type": "object", "x-aura-field-code": "paybackPlanList" } }, "paybackPlanMethod": { "type": "integer", "format": "int32", "x-aura-field-code": "paybackPlanMethod" }, "productTaxListOutput": { "type": "array", "items": { "type": "object", "x-aura-field-code": "productTaxListOutput" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "averageMaturity": { "type": "integer", "format": "int32", "x-aura-field-code": "averageMaturity" }, "dayDifferentInstallment": { "type": "string", "x-aura-field-code": "dayDifferentInstallment" }, "dayInYearCount": { "type": "string", "x-aura-field-code": "dayInYearCount" }, "loanProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanProductId" }, "paybackPlanList": { "type": "array", "items": { "type": "object", "x-aura-field-code": "paybackPlanList" } }, "paybackPlanMethod": { "type": "integer", "format": "int32", "x-aura-field-code": "paybackPlanMethod" }, "productTaxListOutput": { "type": "array", "items": { "type": "object", "x-aura-field-code": "productTaxListOutput" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-calculate-payback-plan-external-firm-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/loan/external-firm/calculate-payback-plan", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/loan/external-firm/calculate-payback-plan-v2": { "post": { "operationId": "aurax-bff-service-dynamic-calculate-payback-plan-external-firm-performance-bpmn", "tags": [ "loan" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-calculate-payback-plan-external-firm-performance-bpmn", "description": "Request and response fields are declared on the routing target `calculate-payback-plan-external-firm-bff`; this entry declares none of its own.\n\nRead from the caller's token, not from the request: customerId.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "firstInstallmentDate": { "type": "string", "format": "date-time", "x-aura-field-code": "firstInstallmentDate" }, "installmentCount": { "type": "integer", "format": "int32", "x-aura-field-code": "installmentCount" }, "itemsInBasket": { "type": "array", "items": { "type": "object", "x-aura-field-code": "itemsInBasket" } }, "loanCurrencyType": { "type": "integer", "format": "int32", "x-aura-field-code": "loanCurrencyType" } }, "required": [ "firstInstallmentDate", "itemsInBasket", "loanCurrencyType" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 4, "claim": 1, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-calculate-payback-plan-external-firm-performance-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/loan/external-firm/calculate-payback-plan-v2", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "structure", "declared_type": "CalculatePaybackPlanDto", "payload": "CalculatePaybackPlanDto", "collection": false, "members": [ { "name": "LoanProductId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ProposalId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "PaybackPlanMethod", "declared_type": "int", "nullable": false, "collection": false }, { "name": "DayDifferentInstallment", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DayInYearCount", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AverageMaturity", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ProductTaxListOutput", "declared_type": "IEnumerable", "nullable": false, "collection": true }, { "name": "PaybackPlanList", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/api/loan/external-firm/create-loan": { "post": { "operationId": "aurax-bff-service-dynamic-create-loan-for-external-firm-bpmn", "tags": [ "loan" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-create-loan-for-external-firm-bpmn", "description": "Request and response fields are declared on the routing target `create-loan-for-external-firm-bpmn`; this entry declares none of its own.\n\nRead from the caller's token, not from the request: customerId.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "bankCode": { "type": "string", "x-aura-field-code": "bankCodeContext" }, "externalReference": { "type": "string", "x-aura-field-code": "externalReference" }, "firstInstallmentDate": { "type": "string", "format": "date-time", "x-aura-field-code": "firstInstallmentDate" }, "installmentCount": { "type": "integer", "format": "int32", "x-aura-field-code": "installmentCount" }, "itemsInBasket": { "type": "array", "items": { "type": "object", "x-aura-field-code": "itemsInBasket" } }, "loanCampaignId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanCampaignId" }, "loanCurrencyType": { "type": "integer", "format": "int32", "x-aura-field-code": "loanCurrencyType" }, "mccCode": { "type": "integer", "format": "int32", "x-aura-field-code": "mccCode" }, "merchantId": { "type": "string", "x-aura-field-code": "merchantId" } }, "required": [ "firstInstallmentDate", "installmentCount", "itemsInBasket", "loanCurrencyType" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 9, "claim": 1, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "loanId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanId" }, "virtualIban": { "type": "string", "x-aura-field-code": "virtualIban" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "loanId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanId" }, "virtualIban": { "type": "string", "x-aura-field-code": "virtualIban" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "loanId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanId" }, "virtualIban": { "type": "string", "x-aura-field-code": "virtualIban" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-create-loan-for-external-firm-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/loan/external-firm/create-loan", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/loan/external-firm/create-loan-return-payment": { "post": { "operationId": "aurax-bff-service-dynamic-create-loan-return-payment-bpmn", "tags": [ "loan" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-create-loan-return-payment-bpmn", "description": "Request and response fields are declared on the routing target `create-loan-return-payment-bpmn`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "loanId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanId" }, "returnDate": { "type": "string", "format": "date-time", "x-aura-field-code": "returnDate" } }, "required": [ "amount", "loanId", "returnDate" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 3, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-create-loan-return-payment-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/loan/external-firm/create-loan-return-payment", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/loan/external-firm/create-loan-v2": { "post": { "operationId": "aurax-bff-create-loan-for-external-firm-performans-bpmn", "tags": [ "loan" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-create-loan-for-external-firm-performans-bpmn", "description": "Request and response fields are declared on the routing target `create-loan-for-external-firm-bff`; this entry declares none of its own.\n\nRead from the caller's token, not from the request: customerId.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "bankCode": { "type": "string", "x-aura-field-code": "bankCodeContext" }, "externalReference": { "type": "string", "x-aura-field-code": "externalReference" }, "itemsInBasket": { "type": "array", "items": { "type": "object", "x-aura-field-code": "itemsInBasket" } }, "loanCampaignId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanCampaignId" }, "loanCurrencyType": { "type": "integer", "format": "int32", "x-aura-field-code": "loanCurrencyType" }, "mccCode": { "type": "integer", "format": "int32", "x-aura-field-code": "mccCode" }, "merchantId": { "type": "string", "x-aura-field-code": "merchantId" }, "paybackPlanId": { "type": "string", "format": "uuid", "x-aura-field-code": "paybackPlanId" }, "proposalId": { "type": "string", "format": "uuid", "x-aura-field-code": "proposalId" } }, "required": [ "itemsInBasket", "loanCurrencyType", "paybackPlanId", "proposalId" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 9, "claim": 1, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-create-loan-for-external-firm-performans-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/loan/external-firm/create-loan-v2", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "structure", "declared_type": "CreateLoanDto", "payload": "CreateLoanDto", "collection": false, "members": [ { "name": "LoanId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "VirtualIban", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LoanStatus", "declared_type": "int", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_BNPLLOAN_100", "status": 400, "message": { "ar": "Due to banking policy rules, your transaction cannot be processed at this time.", "en": "Due to banking policy rules, your transaction cannot be processed at this time.", "tr": "Banka politika kuralları gereğince işleminiz şuanda yapılamıyor." }, "message_available": true, "constant_name": null }, { "code": "ERR_LOAN_16", "status": 400, "message": null, "message_available": false, "constant_name": null }, { "code": "ERR_LOAN_88", "status": 400, "message": null, "message_available": false, "constant_name": null }, { "code": "ERR_LOAN_90", "status": 400, "message": null, "message_available": false, "constant_name": null }, { "code": "ERR_LPRPSL_13", "status": 400, "message": null, "message_available": false, "constant_name": null }, { "code": "ERR_LPRPSL_17", "status": 400, "message": null, "message_available": false, "constant_name": null }, { "code": "ERR_LPRPSL_2", "status": 400, "message": null, "message_available": false, "constant_name": null }, { "code": "ERR_LPRPSL_6", "status": 400, "message": null, "message_available": false, "constant_name": null } ] } } }, "/api/loan/external-firm/details-by-external-reference/{externalReference}": { "get": { "operationId": "aurax-bff-service-dynamic-get-loan-details-by-external-reference", "tags": [ "loan" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-get-loan-details-by-external-reference", "description": "Request and response fields are declared on the routing target `get-loan-details-by-external-reference`; this entry declares none of its own.", "parameters": [ { "name": "externalReference", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "externalReference" } }, { "name": "partnerCode", "in": "header", "required": true, "schema": { "type": "string", "x-aura-field-code": "partnerCode" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 1, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "accountingEntryId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryId" }, "accrualStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "accrualStatus" }, "allotmentQueryId": { "type": "string", "format": "uuid", "x-aura-field-code": "allotmentQueryId" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "loanAmount" }, "cancelDate": { "type": "string", "format": "date-time", "x-aura-field-code": "cancelDate" }, "cancelDescription": { "type": "string", "x-aura-field-code": "cancelDescription" }, "cancelReason": { "type": "string", "x-aura-field-code": "cancelReason" }, "collateralUsages": { "type": "array", "items": { "type": "object", "properties": { "collateralUsageId": { "type": "string", "format": "uuid", "x-aura-field-code": "collateralUsageId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "collateralUsageId" } }, "x-aura-field-code": "collateralUsages" } }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "customerAccountId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerAccountId" }, "customerApplicationId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerApplicationId" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "customerRiskId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerRiskId" }, "delegations": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "delegationAmount" }, "beginDate": { "type": "string", "format": "date-time", "x-aura-field-code": "delegationBeginDate" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "endDate": { "type": "string", "format": "date-time", "x-aura-field-code": "delegationEndDate" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "delegationId" }, "loanDelegationDetail": { "type": "array", "items": { "type": "object", "x-aura-field-code": "loanDelegationDetail" } }, "loanDelegationId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanDelegationId" }, "productCategoryId": { "type": "string", "format": "uuid", "x-aura-field-code": "productCategoryId" }, "productCount": { "type": "integer", "format": "int32", "x-aura-field-code": "productCount" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "delegationStatus" } }, "x-aura-field-code": "delegations" } }, "disbursements": { "type": "array", "items": { "type": "object", "properties": { "accountingEntryId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryId" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "disbursementAmount" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "disbursementDate": { "type": "string", "format": "date-time", "x-aura-field-code": "disbursementDate" }, "exchangeRate": { "type": "number", "format": "decimal", "x-aura-field-code": "exchangeRate" }, "externalVendorAccountId": { "type": "string", "format": "uuid", "x-aura-field-code": "externalVendorAccountId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "disbursementId" }, "internalVendorAccountId": { "type": "string", "format": "uuid", "x-aura-field-code": "internalVendorAccountId" }, "isCancel": { "type": "boolean", "x-aura-field-code": "isCancel" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "disbursementStatus" } }, "x-aura-field-code": "disbursements" } }, "earlyPaymentDiscountRate": { "type": "number", "format": "decimal", "x-aura-field-code": "earlyPaymentDiscountRate" }, "exchangeRate": { "type": "number", "format": "decimal", "x-aura-field-code": "exchangeRate" }, "expenses": { "type": "array", "items": { "type": "object", "properties": { "expenseId": { "type": "string", "format": "uuid", "x-aura-field-code": "expenseId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "expenseId" } }, "x-aura-field-code": "expenses" } }, "externalReference": { "type": "string", "x-aura-field-code": "externalReference" }, "externalTransactionid": { "type": "string", "x-aura-field-code": "externalTransactionid" }, "fundingSource": { "type": "integer", "format": "int32", "x-aura-field-code": "fundingSource" }, "guarantors": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "guarantorAmount" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "guarantorId" }, "proximity": { "type": "integer", "format": "int32", "x-aura-field-code": "proximity" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "guarantorStatus" } }, "x-aura-field-code": "guarantors" } }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "loanId" }, "latePenaltyRate": { "type": "number", "format": "decimal", "x-aura-field-code": "latePenaltyRate" }, "loanCloseDate": { "type": "string", "format": "date-time", "x-aura-field-code": "loanCloseDate" }, "loanCloseType": { "type": "integer", "format": "int32", "x-aura-field-code": "loanCloseType" }, "loanDate": { "type": "string", "format": "date-time", "x-aura-field-code": "loanDate" }, "loanNumber": { "type": "string", "x-aura-field-code": "loanNumber" }, "loanProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanProductId" }, "merchants": { "type": "array", "items": { "type": "object", "x-aura-field-code": "merchants" } }, "orders": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "loanOrderAmount" }, "billNo": { "type": "string", "x-aura-field-code": "billNo" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "externalVendorId": { "type": "string", "format": "uuid", "x-aura-field-code": "externalVendorId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "orderId" }, "internalVendorId": { "type": "string", "format": "uuid", "x-aura-field-code": "internalVendorId" }, "orderDate": { "type": "string", "format": "date-time", "x-aura-field-code": "orderDate" }, "productCount": { "type": "integer", "format": "int32", "x-aura-field-code": "productCount" }, "productName": { "type": "string", "x-aura-field-code": "productName" }, "productType": { "type": "integer", "format": "int32", "x-aura-field-code": "productType" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "loanOrderStatus" } }, "x-aura-field-code": "orders" } }, "organizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "organizationId" }, "parentLoanId": { "type": "string", "format": "uuid", "x-aura-field-code": "parentLoanId" }, "paybackPlans": { "type": "array", "items": { "type": "object", "properties": { "averageMaturity": { "type": "integer", "format": "int32", "x-aura-field-code": "averageMaturity" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "loanPaybackPlanId" }, "installmentCount": { "type": "integer", "format": "int32", "x-aura-field-code": "installmentCount" }, "installments": { "type": "array", "items": { "type": "object", "properties": { "balloonPaymentAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "balloonPaymentAmount" }, "calculateInstallmentDate": { "type": "string", "format": "date-time", "x-aura-field-code": "calculateInstallmentDate" }, "collectionStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "collectionStatus" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "installmentId" }, "installmentDate": { "type": "string", "format": "date-time", "x-aura-field-code": "installmentDate" }, "installmentNo": { "type": "integer", "format": "int32", "x-aura-field-code": "installmentNo" }, "installmentTotalAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "installmentTotalAmount" }, "isAccrual": { "type": "boolean", "x-aura-field-code": "isAccrual" }, "isManual": { "type": "boolean", "x-aura-field-code": "isManual" }, "loanId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanId" }, "loanPaybackPlanId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanPaybackPlanId" }, "principalAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "principalAmount" }, "profitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "profitAmount" }, "remainingPrincipalAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "remainingPrincipalAmount" }, "taxes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "taxId" }, "taxAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "taxAmount" }, "taxId": { "type": "string", "format": "uuid", "x-aura-field-code": "taxId" } }, "x-aura-field-code": "taxes" } } }, "x-aura-field-code": "installments" } }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "monthlyRate": { "type": "number", "format": "decimal", "x-aura-field-code": "monthlyRate" }, "paybackPlanId": { "type": "string", "format": "uuid", "x-aura-field-code": "paybackPlanId" }, "totalAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "totalAmount" }, "totalPaymentAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "totalPaymentAmount" }, "xirr": { "type": "number", "format": "decimal", "x-aura-field-code": "xirr" } }, "x-aura-field-code": "paybackPlans" } }, "proposalId": { "type": "string", "format": "uuid", "x-aura-field-code": "proposalId" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "loanStatus" }, "vendorExternalId": { "type": "string", "format": "uuid", "x-aura-field-code": "externalVendorId" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-get-loan-details-by-external-reference", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/loan/external-firm/details-by-external-reference/{externalReference}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "structure", "declared_type": "LoanDetailsDto", "payload": "LoanDetailsDto", "collection": false, "members": [ { "name": "ChannelType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Id", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CustomerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ProposalId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CustomerApplicationId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CustomerAccountId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "LoanProductId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "LoanNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FundingSource", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "OrganizationId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Amount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "LoanDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "Status", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ExchangeRate", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "AccountingEntryId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "LoanCloseDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "LoanCloseType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CustomerRiskId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "AllotmentQueryId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ParentLoanId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CancelDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "CancelReason", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CancelDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LatePenaltyRate", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "EarlyPaymentDiscountRate", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "AccrualStatus", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ExternalReference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExternalTransactionid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "VendorExternalId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "StatusContext", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PartnerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Disbursements", "declared_type": "List", "nullable": false, "collection": true }, { "name": "PaybackPlans", "declared_type": "List", "nullable": false, "collection": true }, { "name": "CollateralUsages", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Expenses", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Orders", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Delegations", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Guarantors", "declared_type": "List", "nullable": false, "collection": true }, { "name": "ReturnPayments", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Insurances", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Merchants", "declared_type": "List", "nullable": false, "collection": true }, { "name": "PoolDefinitionRates", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LOAN_17", "status": 400, "message": null, "message_available": false, "constant_name": "LOAN_MUST_NOT_BE_NULL" }, { "code": "ERR_LOAN_91", "status": 400, "message": null, "message_available": false, "constant_name": "LOAN_MULTIPLE_ROW_FOUND" } ] } } }, "/api/loan/external-firm/provision-cancel": { "post": { "operationId": "aurax-bff-service-dynamic-provision-cancel-loan-finalization-for-external-firm-bpmn", "tags": [ "loan" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-provision-cancel-loan-finalization-for-external-firm-bpmn", "description": "Request and response fields are declared on the routing target `provision-cancel-loan-finalization-for-external-firm-bpmn`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "billingAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "billingAmount" }, "cardToken": { "type": "string", "x-aura-field-code": "cardToken" }, "mainTrnId": { "type": "integer", "format": "int64", "x-aura-field-code": "mainTrnId" }, "originalMainTrnId": { "type": "integer", "format": "int64", "x-aura-field-code": "originalMainTrnId" }, "reversalReasonCode": { "type": "string", "x-aura-field-code": "reversalReasonCode" }, "transactionAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "transactionAmount" } }, "required": [ "mainTrnId", "originalMainTrnId" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 6, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "feeAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "feeAmount" }, "feeCurrency": { "type": "string", "x-aura-field-code": "feeCurrency" }, "feeTrnCodeMatrixId": { "type": "string", "x-aura-field-code": "feeTrnCodeMatrixId" }, "localFeeAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "localFeeAmount" }, "localFeeCurrency": { "type": "string", "x-aura-field-code": "localFeeCurrency" }, "localTransactionAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "localTransactionAmount" }, "localTransactionCurrency": { "type": "string", "x-aura-field-code": "localTransactionCurrency" }, "resultCode": { "type": "string", "x-aura-field-code": "resultCode" }, "resultMessage": { "type": "string", "x-aura-field-code": "resultMessage" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "feeAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "feeAmount" }, "feeCurrency": { "type": "string", "x-aura-field-code": "feeCurrency" }, "feeTrnCodeMatrixId": { "type": "string", "x-aura-field-code": "feeTrnCodeMatrixId" }, "localFeeAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "localFeeAmount" }, "localFeeCurrency": { "type": "string", "x-aura-field-code": "localFeeCurrency" }, "localTransactionAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "localTransactionAmount" }, "localTransactionCurrency": { "type": "string", "x-aura-field-code": "localTransactionCurrency" }, "resultCode": { "type": "string", "x-aura-field-code": "resultCode" }, "resultMessage": { "type": "string", "x-aura-field-code": "resultMessage" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "feeAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "feeAmount" }, "feeCurrency": { "type": "string", "x-aura-field-code": "feeCurrency" }, "feeTrnCodeMatrixId": { "type": "string", "x-aura-field-code": "feeTrnCodeMatrixId" }, "localFeeAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "localFeeAmount" }, "localFeeCurrency": { "type": "string", "x-aura-field-code": "localFeeCurrency" }, "localTransactionAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "localTransactionAmount" }, "localTransactionCurrency": { "type": "string", "x-aura-field-code": "localTransactionCurrency" }, "resultCode": { "type": "string", "x-aura-field-code": "resultCode" }, "resultMessage": { "type": "string", "x-aura-field-code": "resultMessage" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-provision-cancel-loan-finalization-for-external-firm-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/loan/external-firm/provision-cancel", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/loan/external-firm/provision-confirm": { "post": { "operationId": "aurax-bff-service-dynamic-provision-confirm-loan-finalization-for-external-firm-bpmn", "tags": [ "loan" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-provision-confirm-loan-finalization-for-external-firm-bpmn", "description": "Request and response fields are declared on the routing target `provision-confirm-loan-finalization-for-external-firm-bpmn`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "acquirerInstutionId": { "type": "string", "x-aura-field-code": "acquirerInstutionId" }, "billingAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "billingAmount" }, "billingCurrencyCode": { "type": "string", "x-aura-field-code": "billingCurrencyCode" }, "cardToken": { "type": "string", "x-aura-field-code": "cardToken" }, "channelType": { "type": "string", "x-aura-field-code": "externalChannelType" }, "description": { "type": "string", "x-aura-field-code": "description" }, "isInternational": { "type": "boolean", "x-aura-field-code": "isInternational" }, "isProvision": { "type": "boolean", "x-aura-field-code": "isProvision" }, "localDateTime": { "type": "string", "format": "date", "x-aura-field-code": "localDateTime" }, "mainTrnId": { "type": "integer", "format": "int64", "x-aura-field-code": "mainTrnId" }, "mccCode": { "type": "integer", "format": "int32", "x-aura-field-code": "mccCode" }, "merchantId": { "type": "string", "x-aura-field-code": "merchantId" }, "posEntryMode": { "type": "string", "x-aura-field-code": "posEntryMode" }, "qrRefID": { "type": "string", "x-aura-field-code": "qrReference" }, "refTrnId": { "type": "integer", "format": "int32", "x-aura-field-code": "refTrnId" }, "terminalId": { "type": "string", "x-aura-field-code": "terminalId" }, "terminalType": { "type": "string", "x-aura-field-code": "terminalType" }, "transactionAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "transactionAmount" }, "transactionCurrencyCode": { "type": "string", "x-aura-field-code": "transactionCurrencyCode" }, "trnCodeMatrixId": { "type": "string", "x-aura-field-code": "trnCodeMatrixId" } }, "required": [ "mainTrnId", "qrRefID", "refTrnId" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 20, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "feeAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "feeAmount" }, "feeCurrency": { "type": "string", "x-aura-field-code": "feeCurrency" }, "feeTrnCodeMatrixId": { "type": "string", "x-aura-field-code": "feeTrnCodeMatrixId" }, "localFeeAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "localFeeAmount" }, "localFeeCurrency": { "type": "string", "x-aura-field-code": "localFeeCurrency" }, "localTransactionAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "localTransactionAmount" }, "localTransactionCurrency": { "type": "string", "x-aura-field-code": "localTransactionCurrency" }, "resultCode": { "type": "string", "x-aura-field-code": "resultCode" }, "resultMessage": { "type": "string", "x-aura-field-code": "resultMessage" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "feeAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "feeAmount" }, "feeCurrency": { "type": "string", "x-aura-field-code": "feeCurrency" }, "feeTrnCodeMatrixId": { "type": "string", "x-aura-field-code": "feeTrnCodeMatrixId" }, "localFeeAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "localFeeAmount" }, "localFeeCurrency": { "type": "string", "x-aura-field-code": "localFeeCurrency" }, "localTransactionAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "localTransactionAmount" }, "localTransactionCurrency": { "type": "string", "x-aura-field-code": "localTransactionCurrency" }, "resultCode": { "type": "string", "x-aura-field-code": "resultCode" }, "resultMessage": { "type": "string", "x-aura-field-code": "resultMessage" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "feeAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "feeAmount" }, "feeCurrency": { "type": "string", "x-aura-field-code": "feeCurrency" }, "feeTrnCodeMatrixId": { "type": "string", "x-aura-field-code": "feeTrnCodeMatrixId" }, "localFeeAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "localFeeAmount" }, "localFeeCurrency": { "type": "string", "x-aura-field-code": "localFeeCurrency" }, "localTransactionAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "localTransactionAmount" }, "localTransactionCurrency": { "type": "string", "x-aura-field-code": "localTransactionCurrency" }, "resultCode": { "type": "string", "x-aura-field-code": "resultCode" }, "resultMessage": { "type": "string", "x-aura-field-code": "resultMessage" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-provision-confirm-loan-finalization-for-external-firm-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/loan/external-firm/provision-confirm", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/loan/external-firm/return-payments": { "get": { "operationId": "aurax-bff-service-dynamic-get-external-firm-loans-return-payments", "tags": [ "loan" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-get-external-firm-loans-return-payments", "description": "Request and response fields are declared on the routing target `get-loan-return-payment-list-by-date`; this entry declares none of its own.", "parameters": [ { "name": "beginDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time", "x-aura-field-code": "beginDate" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "x-aura-field-code": "endDate" } }, { "name": "partnerCode", "in": "header", "required": true, "schema": { "type": "string", "x-aura-field-code": "partnerCode" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 1, "path": 0, "query": 2 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a collection.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-get-external-firm-loans-return-payments", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/loan/external-firm/return-payments", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "LoanReturnPaymentExternalDto", "collection": true, "members": [ { "name": "ExternalReference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "LoanReturnPayments", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/api/loan/external-firm/transactions": { "get": { "operationId": "aurax-bff-service-dynamic-get-external-firm-loans-details", "tags": [ "loan" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-get-external-firm-loans-details", "description": "Request and response fields are declared on the routing target `get-external-firm-loans-details`; this entry declares none of its own.\n\nDeclared as Route-bound but absent from the route template, so not sendable: beginDate, endDate.", "parameters": [ { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy", "default": "transactionDate" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize", "default": "0" } }, { "name": "partnerCode", "in": "header", "required": true, "schema": { "type": "string", "x-aura-field-code": "partnerCode" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 1, "path": 2, "query": 4 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-get-external-firm-loans-details", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/loan/external-firm/transactions", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-external-firm-loans-details`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/loan/external-firm/transactions-summary": { "get": { "operationId": "aurax-bff-service-dynamic-get-external-firm-loans-summary", "tags": [ "loan" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-get-external-firm-loans-summary", "description": "Request and response fields are declared on the routing target `get-external-firm-loans-summary`; this entry declares none of its own.\n\nDeclared as Route-bound but absent from the route template, so not sendable: beginDate, endDate.", "parameters": [ { "name": "partnerCode", "in": "header", "required": true, "schema": { "type": "string", "x-aura-field-code": "partnerCode" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 1, "path": 2, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-get-external-firm-loans-summary", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/loan/external-firm/transactions-summary", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/loan/first-installment-date": { "post": { "operationId": "aurax-bff-service-dynamic-calculate-first-installment-date-bpmn", "tags": [ "loan" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-calculate-first-installment-date-bpmn", "description": "Read from the caller's token, not from the request: customerId.", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "query", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": false, "declared_root_fields_by_binding_source": { "body": 0, "claim": 1, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "This usage type is outside the invocation layer's filtered set, so that layer applies no binding-source filter at all and every declared source is passed through.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-calculate-first-installment-date-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/loan/first-installment-date", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/loan/get-customer-unpaid-installment-list": { "get": { "operationId": "aurax-bff-service-dynamic-get-unpaid-installment-list-by-customer-id-bpmn", "tags": [ "loan" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-get-unpaid-installment-list-by-customer-id-bpmn", "description": "Request and response fields are declared on the routing target `get-unpaid-installment-list-by-customer-id-bpmn`; this entry declares none of its own.\n\nRead from the caller's token, not from the request: customerId.", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 1, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "currentDate": { "type": "string", "format": "date", "x-aura-field-code": "currentDate" }, "delayedInstallmentCount": { "type": "integer", "format": "int32", "x-aura-field-code": "delayedInstallmentCount" }, "installments": { "type": "array", "items": { "type": "object", "x-aura-field-code": "installments" } }, "upcomingPaymentAmount": { "type": "number", "x-aura-field-code": "upcomingPaymentAmount" }, "upcomingPaymentDate": { "type": "string", "format": "date", "x-aura-field-code": "upcomingPaymentDate" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "currentDate": { "type": "string", "format": "date", "x-aura-field-code": "currentDate" }, "delayedInstallmentCount": { "type": "integer", "format": "int32", "x-aura-field-code": "delayedInstallmentCount" }, "installments": { "type": "array", "items": { "type": "object", "x-aura-field-code": "installments" } }, "upcomingPaymentAmount": { "type": "number", "x-aura-field-code": "upcomingPaymentAmount" }, "upcomingPaymentDate": { "type": "string", "format": "date", "x-aura-field-code": "upcomingPaymentDate" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "currentDate": { "type": "string", "format": "date", "x-aura-field-code": "currentDate" }, "delayedInstallmentCount": { "type": "integer", "format": "int32", "x-aura-field-code": "delayedInstallmentCount" }, "installments": { "type": "array", "items": { "type": "object", "x-aura-field-code": "installments" } }, "upcomingPaymentAmount": { "type": "number", "x-aura-field-code": "upcomingPaymentAmount" }, "upcomingPaymentDate": { "type": "string", "format": "date", "x-aura-field-code": "upcomingPaymentDate" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-get-unpaid-installment-list-by-customer-id-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/loan/get-customer-unpaid-installment-list", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/loan/get-customer-unpaid-installment-list-by-citizen-id": { "get": { "operationId": "aurax-bff-service-dynamic-get-unpaid-installment-list-by-citizen-id-bpmn", "tags": [ "loan" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-get-unpaid-installment-list-by-citizen-id-bpmn", "description": "Request and response fields are declared on the routing target `get-unpaid-installment-list-by-citizen-id-bpmn`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true } }, "required": [ "citizenid" ] } } }, "description": "The catalog declares Body-bound fields on this GET operation. Request bodies on GET have no defined semantics in HTTP; this documents the catalog, not a recommendation. Not every field below is accepted: the platform selects which of them this operation admits and drops the rest. Of the fields below, the binder does not admit `citizenid`, which this document nevertheless marks required because the catalog declares it so.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [ "body" ], "dropped_field_names": { "body": [ "citizenid" ] }, "dropped_mandatory_field_names": [ "citizenid" ], "verdict": "declared-fields-not-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": "The HTTP edge in front of this operation comes in two shapes and they differ: the platform's typed route readers bind GET and DELETE from the URL and never read a body, while its untyped catalog-redirect reader collects the body whenever the request carries one. It does not change the answer above: the selection below happens after the edge, and excludes these fields either way." }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "loans": { "type": "array", "items": { "type": "object", "x-aura-field-code": "loans" } } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "loans": { "type": "array", "items": { "type": "object", "x-aura-field-code": "loans" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "loans": { "type": "array", "items": { "type": "object", "x-aura-field-code": "loans" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-get-unpaid-installment-list-by-citizen-id-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/loan/get-customer-unpaid-installment-list-by-citizen-id", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/loan/installment-payment-amount": { "get": { "operationId": "aurax-bff-service-dynamic-calculate-installment-payment-amount-bpmn", "tags": [ "loan" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-calculate-installment-payment-amount-bpmn", "description": "Request and response fields are declared on the routing target `calculate-installment-payment-amount-bpmn`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "installmentId": { "type": "string", "format": "uuid", "x-aura-field-code": "installmentId" } }, "required": [ "installmentId" ] } } }, "description": "The catalog declares Body-bound fields on this GET operation. Request bodies on GET have no defined semantics in HTTP; this documents the catalog, not a recommendation. Not every field below is accepted: the platform selects which of them this operation admits and drops the rest. Of the fields below, the binder does not admit `installmentId`, which this document nevertheless marks required because the catalog declares it so.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [ "body" ], "dropped_field_names": { "body": [ "installmentId" ] }, "dropped_mandatory_field_names": [ "installmentId" ], "verdict": "declared-fields-not-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": "The HTTP edge in front of this operation comes in two shapes and they differ: the platform's typed route readers bind GET and DELETE from the URL and never read a body, while its untyped catalog-redirect reader collects the body whenever the request carries one. It does not change the answer above: the selection below happens after the edge, and excludes these fields either way." }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "installment": { "type": "object", "x-aura-field-code": "installment" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "installment": { "type": "object", "x-aura-field-code": "installment" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "installment": { "type": "object", "x-aura-field-code": "installment" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-calculate-installment-payment-amount-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/loan/installment-payment-amount", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/loan/installments-debt-amount": { "post": { "operationId": "aurax-bff-service-dynamic-calculate-installments-debt-amount-bpmn", "tags": [ "loan" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-calculate-installments-debt-amount-bpmn", "description": "Request and response fields are declared on the routing target `calculate-installments-debt-amount-bpmn`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "installmentIdList": { "type": "array", "items": { "type": "string", "format": "uuid", "x-aura-field-code": "installmentIdList" } } }, "required": [ "installmentIdList" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "installments": { "type": "array", "items": { "type": "object", "x-aura-field-code": "installments" } }, "totalRemainingAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "totalRemainingAmount" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "installments": { "type": "array", "items": { "type": "object", "x-aura-field-code": "installments" } }, "totalRemainingAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "totalRemainingAmount" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "installments": { "type": "array", "items": { "type": "object", "x-aura-field-code": "installments" } }, "totalRemainingAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "totalRemainingAmount" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-calculate-installments-debt-amount-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/loan/installments-debt-amount", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/loan/loan-finalization-mobil-test-bpmn": { "post": { "operationId": "aurax-bff-service-dynamic-loan-finalization-mobil-test-bpmn", "tags": [ "loan" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-loan-finalization-mobil-test-bpmn", "description": "Request and response fields are declared on the routing target `loan-finalization-mobil-test-bpmn`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "loanId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanId" } }, "required": [ "loanId" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-loan-finalization-mobil-test-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/loan/loan-finalization-mobil-test-bpmn", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/loan/uncollected-installment-count": { "post": { "operationId": "aurax-bff-service-dynamic-get-loan-delayed-installment-count-bpmn", "tags": [ "loan" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-get-loan-delayed-installment-count-bpmn", "description": "Request and response fields are declared on the routing target `get-loan-delayed-installment-count-bpmn`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "loanId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanId" } }, "required": [ "loanId" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "delayedInstallmentCount": { "type": "integer", "format": "int32", "x-aura-field-code": "delayedInstallmentCount" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "delayedInstallmentCount": { "type": "integer", "format": "int32", "x-aura-field-code": "delayedInstallmentCount" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "delayedInstallmentCount": { "type": "integer", "format": "int32", "x-aura-field-code": "delayedInstallmentCount" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-get-loan-delayed-installment-count-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/loan/uncollected-installment-count", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/loan/{id}/details": { "get": { "operationId": "aurax-bff-service-dynamic-get-loan-details-by-id", "tags": [ "loan" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-get-loan-details-by-id", "description": "Request and response fields are declared on the routing target `get-loan-details-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "loanId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "accountingEntryId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryId" }, "accrualStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "accrualStatus" }, "allotmentQueryId": { "type": "string", "format": "uuid", "x-aura-field-code": "allotmentQueryId" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "loanAmount" }, "cancelDate": { "type": "string", "format": "date-time", "x-aura-field-code": "cancelDate" }, "cancelDescription": { "type": "string", "x-aura-field-code": "cancelDescription" }, "cancelReason": { "type": "string", "x-aura-field-code": "cancelReason" }, "collateralUsages": { "type": "array", "items": { "type": "object", "properties": { "collateralUsageId": { "type": "string", "format": "uuid", "x-aura-field-code": "collateralUsageId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "collateralUsageId" } }, "x-aura-field-code": "collateralUsages" } }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "customerAccountId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerAccountId" }, "customerApplicationId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerApplicationId" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "customerRiskId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerRiskId" }, "delegations": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "delegationAmount" }, "beginDate": { "type": "string", "format": "date-time", "x-aura-field-code": "delegationBeginDate" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "endDate": { "type": "string", "format": "date-time", "x-aura-field-code": "delegationEndDate" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "delegationId" }, "productCount": { "type": "integer", "format": "int32", "x-aura-field-code": "productCount" }, "productName": { "type": "string", "x-aura-field-code": "productName" }, "productType": { "type": "integer", "format": "int32", "x-aura-field-code": "productType" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "delegationStatus" } }, "x-aura-field-code": "delegations" } }, "disbursements": { "type": "array", "items": { "type": "object", "properties": { "accountingEntryId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryId" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "disbursementAmount" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "disbursementDate": { "type": "string", "format": "date-time", "x-aura-field-code": "disbursementDate" }, "exchangeRate": { "type": "number", "format": "decimal", "x-aura-field-code": "exchangeRate" }, "externalVendorAccountId": { "type": "string", "format": "uuid", "x-aura-field-code": "externalVendorAccountId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "disbursementId" }, "internalVendorAccountId": { "type": "string", "format": "uuid", "x-aura-field-code": "internalVendorAccountId" }, "isCancel": { "type": "boolean", "x-aura-field-code": "isCancel" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "disbursementStatus" } }, "x-aura-field-code": "disbursements" } }, "earlyPaymentDiscountRate": { "type": "number", "format": "decimal", "x-aura-field-code": "earlyPaymentDiscountRate" }, "exchangeRate": { "type": "number", "format": "decimal", "x-aura-field-code": "exchangeRate" }, "expenses": { "type": "array", "items": { "type": "object", "properties": { "expenseId": { "type": "string", "format": "uuid", "x-aura-field-code": "expenseId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "expenseId" } }, "x-aura-field-code": "expenses" } }, "externalReference": { "type": "string", "x-aura-field-code": "externalReference" }, "externalTransactionid": { "type": "string", "x-aura-field-code": "externalTransactionid" }, "fundingSource": { "type": "integer", "format": "int32", "x-aura-field-code": "fundingSource" }, "guarantors": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "guarantorAmount" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "guarantorId" }, "personId": { "type": "string", "format": "uuid", "x-aura-field-code": "personId" }, "proximity": { "type": "integer", "format": "int32", "x-aura-field-code": "proximity" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "guarantorStatus" } }, "x-aura-field-code": "guarantors" } }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "loanId" }, "insurances": { "type": "array", "items": { "type": "object", "properties": { "chassisNumber": { "type": "string", "x-aura-field-code": "chassisNumber" }, "company": { "type": "string", "x-aura-field-code": "company" }, "coverageAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "coverageAmount" }, "coverageCurrencyNumber": { "type": "string", "x-aura-field-code": "coverageCurrencyNumber" }, "endDate": { "type": "string", "format": "date-time", "x-aura-field-code": "insuranceEndDate" }, "engineNumber": { "type": "string", "x-aura-field-code": "engineNumber" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "insuranceId" }, "loanId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanId" }, "lossPayee": { "type": "string", "x-aura-field-code": "lossPayee" }, "plate": { "type": "string", "x-aura-field-code": "plate" }, "policyHolderFullname": { "type": "string", "x-aura-field-code": "policyHolderFullname" }, "policyHolderNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "policyHolderNumber" }, "policyNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "policyNumber" }, "premiumAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "premiumAmount" }, "premiumCurrencyNumber": { "type": "string", "x-aura-field-code": "premiumCurrencyId" }, "productName": { "type": "string", "x-aura-field-code": "productName" }, "startDate": { "type": "string", "format": "date-time", "x-aura-field-code": "insuranceStartDate" }, "type": { "type": "integer", "format": "int32", "x-aura-field-code": "insuranceType" }, "vehicleBrand": { "type": "string", "x-aura-field-code": "vehicleBrand" }, "vehicleModel": { "type": "string", "x-aura-field-code": "vehicleModel" }, "vehicleType": { "type": "string", "x-aura-field-code": "vehicleType" } }, "x-aura-field-code": "insurances" } }, "latePenaltyRate": { "type": "number", "format": "decimal", "x-aura-field-code": "latePenaltyRate" }, "loanCloseDate": { "type": "string", "format": "date-time", "x-aura-field-code": "loanCloseDate" }, "loanCloseType": { "type": "integer", "format": "int32", "x-aura-field-code": "loanCloseType" }, "loanDate": { "type": "string", "format": "date-time", "x-aura-field-code": "loanDate" }, "loanNumber": { "type": "string", "x-aura-field-code": "loanNumber" }, "loanProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanProductId" }, "orders": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "loanOrderAmount" }, "billNo": { "type": "string", "x-aura-field-code": "billNo" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "externalVendorId": { "type": "string", "format": "uuid", "x-aura-field-code": "externalVendorId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "orderId" }, "internalVendorId": { "type": "string", "format": "uuid", "x-aura-field-code": "internalVendorId" }, "orderDate": { "type": "string", "format": "date-time", "x-aura-field-code": "orderDate" }, "productCount": { "type": "integer", "format": "int32", "x-aura-field-code": "productCount" }, "productName": { "type": "string", "x-aura-field-code": "productName" }, "productType": { "type": "integer", "format": "int32", "x-aura-field-code": "productType" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "loanOrderStatus" } }, "x-aura-field-code": "orders" } }, "organizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "organizationId" }, "parentLoanId": { "type": "string", "format": "uuid", "x-aura-field-code": "parentLoanId" }, "partnerId": { "type": "string", "format": "uuid", "x-aura-field-code": "partnerId" }, "paybackPlans": { "type": "array", "items": { "type": "object", "properties": { "averageMaturity": { "type": "integer", "format": "int32", "x-aura-field-code": "averageMaturity" }, "compoundInterestRate": { "type": "number", "format": "decimal", "x-aura-field-code": "compoundInterestRate" }, "effectiveInterestRate": { "type": "number", "format": "decimal", "x-aura-field-code": "effectiveInterestRate" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "loanPaybackPlanId" }, "installmentCount": { "type": "integer", "format": "int32", "x-aura-field-code": "installmentCount" }, "installments": { "type": "array", "items": { "type": "object", "properties": { "balloonPaymentAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "balloonPaymentAmount" }, "calculateInstallmentDate": { "type": "string", "format": "date-time", "x-aura-field-code": "calculateInstallmentDate" }, "collectionStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "collectionStatus" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "installmentId" }, "installmentDate": { "type": "string", "format": "date-time", "x-aura-field-code": "installmentDate" }, "installmentNo": { "type": "integer", "format": "int32", "x-aura-field-code": "installmentNo" }, "installmentTotalAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "installmentTotalAmount" }, "isAccrual": { "type": "boolean", "x-aura-field-code": "isAccrual" }, "isManual": { "type": "boolean", "x-aura-field-code": "isManual" }, "principalAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "principalAmount" }, "profitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "profitAmount" }, "remainingPrincipalAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "remainingPrincipalAmount" }, "taxes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "loanPaybackPlanInstallmentTaxId" }, "taxAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "taxAmount" }, "taxId": { "type": "string", "format": "uuid", "x-aura-field-code": "taxId" } }, "x-aura-field-code": "taxes" } } }, "x-aura-field-code": "installments" } }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "monthlyRate": { "type": "number", "format": "decimal", "x-aura-field-code": "monthlyRate" }, "paybackPlanId": { "type": "string", "format": "uuid", "x-aura-field-code": "paybackPlanId" }, "totalAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "totalAmount" }, "totalPaymentAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "totalPaymentAmount" }, "xirr": { "type": "number", "format": "decimal", "x-aura-field-code": "xirr" } }, "x-aura-field-code": "paybackPlans" } }, "poolDefinitionRates": { "type": "array", "items": { "type": "object", "properties": { "loanPoolDefinitionRateId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanPoolDefinitionRateId" }, "poolDefinitionRateId": { "type": "string", "format": "uuid", "x-aura-field-code": "poolDefinitionRateId" } }, "x-aura-field-code": "poolDefinitionRates" } }, "proposalId": { "type": "string", "format": "uuid", "x-aura-field-code": "proposalId" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "loanStatus" }, "vendorExternalId": { "type": "string", "format": "uuid", "x-aura-field-code": "externalVendorId" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-get-loan-details-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/loan/{id}/details", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "structure", "declared_type": "LoanDetailsDto", "payload": "LoanDetailsDto", "collection": false, "members": [ { "name": "ChannelType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Id", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CustomerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ProposalId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CustomerApplicationId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CustomerAccountId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "LoanProductId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "LoanNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FundingSource", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "OrganizationId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Amount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "LoanDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "Status", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ExchangeRate", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "AccountingEntryId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "LoanCloseDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "LoanCloseType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CustomerRiskId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "AllotmentQueryId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ParentLoanId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CancelDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "CancelReason", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CancelDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LatePenaltyRate", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "EarlyPaymentDiscountRate", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "AccrualStatus", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ExternalReference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExternalTransactionid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "VendorExternalId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "StatusContext", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PartnerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Disbursements", "declared_type": "List", "nullable": false, "collection": true }, { "name": "PaybackPlans", "declared_type": "List", "nullable": false, "collection": true }, { "name": "CollateralUsages", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Expenses", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Orders", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Delegations", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Guarantors", "declared_type": "List", "nullable": false, "collection": true }, { "name": "ReturnPayments", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Insurances", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Merchants", "declared_type": "List", "nullable": false, "collection": true }, { "name": "PoolDefinitionRates", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LOAN_17", "status": 400, "message": null, "message_available": false, "constant_name": "LOAN_MUST_NOT_BE_NULL" } ] } } }, "/api/loans/cancel": { "post": { "operationId": "aurax-bff-service-dynamic-aurax-bff-redirect-cancel-loan-bpmn", "tags": [ "loans" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "Cancel Loan Bpmn", "description": "Invokes the `aurax-bff-service-dynamic-aurax-bff-redirect-cancel-loan-bpmn` service definition through `POST /api/loans/cancel`.\n\nRequest and response fields are declared on the routing target `cancel-loan-bpmn`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "isLoanDisbursementEdit": { "type": "boolean", "x-aura-field-code": "isLoanDisbursementEdit" }, "loanCancelDescription": { "type": "string", "x-aura-field-code": "loanCancelDescription" }, "loanCancelReason": { "type": "integer", "format": "int32", "x-aura-field-code": "loanCancelReason" }, "loanId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanId" } }, "required": [ "loanCancelDescription", "loanCancelReason", "loanId" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 4, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "reverseAccountingEntryId": { "type": "string", "format": "uuid", "x-aura-field-code": "reverseAccountingEntryId" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "reverseAccountingEntryId": { "type": "string", "format": "uuid", "x-aura-field-code": "reverseAccountingEntryId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "reverseAccountingEntryId": { "type": "string", "format": "uuid", "x-aura-field-code": "reverseAccountingEntryId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-aurax-bff-redirect-cancel-loan-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/loans/cancel", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/mail-notifications/details": { "get": { "operationId": "aurax-bff-redirect-get-mail-notification-detail-list", "tags": [ "mail-notifications" ], "summary": "aurax-bff-redirect-get-mail-notification-detail-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-mail-notification-detail-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/mail-notifications/details", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/notification-providers/mail-results": { "get": { "operationId": "aurax-bff-redirect-get-notification-mail-result-list", "tags": [ "notification-providers" ], "summary": "aurax-bff-redirect-get-notification-mail-result-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. It returns a page of records under `data`, with `total` carrying the unpaged count — but the record's fields are not declared.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-notification-mail-result-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/notification-providers/mail-results", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/notification-providers/sms-results": { "get": { "operationId": "aurax-bff-dynamic-get-notification-sms-result-list", "tags": [ "notification-providers" ], "summary": "aurax-bff-dynamic-get-notification-sms-result-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": false, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "This usage type is outside the invocation layer's filtered set, so that layer applies no binding-source filter at all and every declared source is passed through.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. It returns a page of records under `data`, with `total` carrying the unpaged count — but the record's fields are not declared.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-notification-sms-result-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/notification-providers/sms-results", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/occupation-types/{id}/fields": { "get": { "operationId": "aurax-bff-service-dynamic-get-occupation-type-field-list", "tags": [ "occupation-types" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-get-occupation-type-field-list", "description": "Request and response fields are declared on the routing target `get-occupation-type-field-list`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "occupationTypeId" } }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 3 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "fieldKey": { "type": "string", "x-aura-field-code": "occupationTypeFieldKey" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "occupationTypeFieldId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "sequenceNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "sequenceNumber" }, "translations": { "type": "array", "items": { "type": "object", "properties": { "languageCode": { "type": "string", "x-aura-field-code": "languageCode" }, "name": { "type": "string", "x-aura-field-code": "translations_name" } }, "x-aura-field-code": "translations" } }, "typeId": { "type": "string", "format": "uuid", "x-aura-field-code": "occupationTypeId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-get-occupation-type-field-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/occupation-types/{id}/fields", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "note": "Platform-provided behaviours declared on the routing target `get-occupation-type-field-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/otp-items/by-transaction-id/{transactionId}/confirm": { "get": { "operationId": "aurax-bff-redirect-get-otp-confirm-by-transaction-id", "tags": [ "otp-items" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-otp-confirm-by-transaction-id", "description": "Request and response fields are declared on the routing target `get-otp-confirm-by-transaction-id`; this entry declares none of its own.", "parameters": [ { "name": "transactionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "transactionId" } }, { "name": "oneTimePassword", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "oneTimePassword", "x-aura-encrypted": true } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 1 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-otp-confirm-by-transaction-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/otp-items/by-transaction-id/{transactionId}/confirm", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "declared-non-dto", "note": "The route returns `bool`, a scalar rather than an object. There is no field tree below because there are no fields: the body is the JSON literal `true` or `false`. This is a complete answer read from the declaration, not a gap.", "declared_type": "bool", "payload": "bool" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_OTP_12", "status": 400, "message": null, "message_available": false, "constant_name": "OTP_TRANSACTION_ALREADY_CONFIRMED" }, { "code": "ERR_OTP_4", "status": 400, "message": null, "message_available": false, "constant_name": "OTP_TRANSACTION_IS_NOT_FOUND" }, { "code": "ERR_OTP_8", "status": 400, "message": null, "message_available": false, "constant_name": "OTP_HAS_EXPIRED" }, { "code": "ERR_OTP_9", "status": 400, "message": null, "message_available": false, "constant_name": "OTP_IS_INVALID" } ] } } }, "/api/payback-plans/calculate": { "post": { "operationId": "aurax-bff-service-dynamic-calculate-generic-payback-plan", "tags": [ "payback-plans" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-calculate-generic-payback-plan", "description": "Request and response fields are declared on the routing target `calculate-generic-payback-plan`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "paybackPlanAmount" }, "annualInterestRate": { "type": "number", "format": "decimal", "x-aura-field-code": "annualInterestRate" }, "dayDifferentInstallment": { "type": "string", "x-aura-field-code": "dayDifferentInstallment" }, "dayInYearCount": { "type": "string", "x-aura-field-code": "dayInYearCount" }, "expenseAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "expenseAmount" }, "firstInstallmentDate": { "type": "string", "format": "date-time", "x-aura-field-code": "firstInstallmentDate" }, "installmentCount": { "type": "integer", "format": "int32", "x-aura-field-code": "installmentCount" }, "installments": { "type": "array", "items": { "type": "object", "properties": { "balloonPaymentAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "balloonPaymentAmount" }, "installmentAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "installmentAmount" }, "installmentDate": { "type": "string", "format": "date-time", "x-aura-field-code": "installmentDate" }, "installmentSequenceNo": { "type": "integer", "format": "int32", "x-aura-field-code": "installmentSequenceNo" } }, "required": [ "balloonPaymentAmount", "installmentAmount", "installmentDate", "installmentSequenceNo" ], "x-aura-field-code": "installments" } }, "monthlyRepaymentRate": { "type": "number", "format": "decimal", "x-aura-field-code": "monthlyRepaymentRate" }, "paybackPlanMethod": { "type": "integer", "format": "int32", "x-aura-field-code": "paybackPlanMethod", "x-aura-parameter-enumeration": { "state": "resolved", "parameter": "payback_plan_method", "values": [ { "value": 11, "name": "Düzensiz ödemeli", "labels": { "en": "Irregular Installment", "tr": "Düzensiz ödemeli" } }, { "value": 2, "name": "Eşit taksit tutarlı", "labels": { "en": "Equal Installment", "tr": "Eşit Taksit Tutarlı" } }, { "value": 4, "name": "Değişken Faizli", "labels": { "en": "Variable Interest", "tr": "Değişken Faizli" } }, { "value": 10, "name": "Balon Ödeme", "labels": { "en": "Balloon Installment", "tr": "Balon Ödeme" } }, { "value": 12, "name": "Spot Loan", "labels": { "en": "Spot Loan", "tr": "Spot Kredi" } } ] } }, "paymentDate": { "type": "string", "format": "date-time", "x-aura-field-code": "paymentDate" }, "postponedInstallmentCount": { "type": "integer", "format": "int32", "x-aura-field-code": "postponedInstallmentCount" }, "taxes": { "type": "array", "items": { "type": "object", "properties": { "fromProperty": { "type": "string", "x-aura-field-code": "fromProperty" }, "taxId": { "type": "string", "format": "uuid", "x-aura-field-code": "taxId" }, "taxRate": { "type": "number", "format": "decimal", "x-aura-field-code": "taxRate" } }, "required": [ "fromProperty", "taxId", "taxRate" ], "x-aura-field-code": "taxes" } }, "termInDays": { "type": "integer", "format": "int32", "x-aura-field-code": "termInDays" }, "totalExpenseAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "totalExpenseAmount" } }, "required": [ "amount", "dayDifferentInstallment", "dayInYearCount", "installmentCount", "monthlyRepaymentRate", "paybackPlanMethod", "paymentDate", "taxes" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 15, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-calculate-generic-payback-plan", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/payback-plans/calculate", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "structure", "declared_type": "BasePaybackPlanDto", "payload": "BasePaybackPlanDto", "collection": false, "members": [ { "name": "PaymentDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "FirstInstallmentDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "TotalPaymentAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "IRR", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "XIRR", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "EffectiveInterestRate", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "CompoundInterestRate", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "AverageMaturity", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Installments", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_PYBCKPLAN_18", "status": 400, "message": { "ar": "لا يمكن أن تكون مواعيد الأقساط أقل من تاريخ الدفع.", "en": "The installment dates cannot be less than the payment date.", "tr": "Taksit tarihleri ödeme tarihinden az olamaz." }, "message_available": true, "constant_name": "PAYBACK_PLAN_INSTALLMENT_DATE_GREATER_THAN_PAYMENT_DATE" }, { "code": "ERR_PYBCKPLAN_9", "status": 400, "message": { "ar": "يجب أن يكون عدد الأقساط في مصفوفة الأقساط متوافقًا مع عدد الأقساط.", "en": "The number of installments in the installment array must be compatible with the installment count.", "tr": "Taksit dizisindeki taksit sayısı taksit sayısı ile uyumlu olmalıdır." }, "message_available": true, "constant_name": "PAYBACK_PLAN_COMPATIBLE_INSTALLMENT_COUNT_CONTROL" } ] } } }, "/api/product-categories": { "get": { "operationId": "aurax-bff-service-dynamic-get-product-category-list", "tags": [ "product-categories" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-get-product-category-list", "description": "Request and response fields are declared on the routing target `get-product-category-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "alternativeInstallmentOption": { "type": "string", "x-aura-field-code": "alternativeInstallmentOption" }, "code": { "type": "string", "x-aura-field-code": "productCategoryCode" }, "description": { "type": "string", "x-aura-field-code": "productCategoryDescription" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "productCategoryId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "maxInstallmentNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "maxInstallmentNumber" }, "name": { "type": "string", "x-aura-field-code": "productCategoryName" }, "parentProductCategoryId": { "type": "string", "format": "uuid", "x-aura-field-code": "parentProductCategoryId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-get-product-category-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/product-categories", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "caching": true, "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-product-category-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "ProductCategoryDto", "collection": true, "members": [ { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MaxInstallmentNumber", "declared_type": "int", "nullable": false, "collection": false }, { "name": "AlternativeInstallmentOption", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ParentProductCategoryId", "declared_type": "Guid?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/api/realms/{realm}/protocol/openid-connect/token": { "post": { "operationId": "aurax-bff-service-dynamic-get-token-by-grant-type", "tags": [ "realms" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-get-token-by-grant-type", "description": "Request and response fields are declared on the routing target `get-token-by-grant-type`; this entry declares none of its own.", "parameters": [ { "name": "realm", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "realm" } } ], "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "client_id": { "type": "string", "x-aura-field-code": "keycloak_client_id" }, "client_secret": { "type": "string", "x-aura-field-code": "clientSecret", "x-aura-maskable": true }, "grant_type": { "type": "string", "x-aura-field-code": "grantType" }, "password": { "type": "string", "x-aura-field-code": "keycloak_password", "x-aura-encrypted": true }, "username": { "type": "string", "x-aura-field-code": "keycloak_username" } }, "required": [ "client_id", "grant_type", "password", "username" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "query", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": false, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 5, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "This usage type is outside the invocation layer's filtered set, so that layer applies no binding-source filter at all and every declared source is passed through.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "access_token": { "type": "string", "x-aura-field-code": "token" }, "expires_in": { "type": "integer", "format": "int32", "x-aura-field-code": "expiresIn" }, "refresh_expires_in": { "type": "integer", "format": "int32", "x-aura-field-code": "refreshExpiresIn" }, "refresh_token": { "type": "string", "x-aura-field-code": "refreshToken" }, "scope": { "type": "string", "x-aura-field-code": "scope" }, "session_state": { "type": "string", "x-aura-field-code": "sessionState" }, "token_type": { "type": "string", "x-aura-field-code": "tokenType" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "access_token": { "type": "string", "x-aura-field-code": "token" }, "expires_in": { "type": "integer", "format": "int32", "x-aura-field-code": "expiresIn" }, "refresh_expires_in": { "type": "integer", "format": "int32", "x-aura-field-code": "refreshExpiresIn" }, "refresh_token": { "type": "string", "x-aura-field-code": "refreshToken" }, "scope": { "type": "string", "x-aura-field-code": "scope" }, "session_state": { "type": "string", "x-aura-field-code": "sessionState" }, "token_type": { "type": "string", "x-aura-field-code": "tokenType" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "access_token": { "type": "string", "x-aura-field-code": "token" }, "expires_in": { "type": "integer", "format": "int32", "x-aura-field-code": "expiresIn" }, "refresh_expires_in": { "type": "integer", "format": "int32", "x-aura-field-code": "refreshExpiresIn" }, "refresh_token": { "type": "string", "x-aura-field-code": "refreshToken" }, "scope": { "type": "string", "x-aura-field-code": "scope" }, "session_state": { "type": "string", "x-aura-field-code": "sessionState" }, "token_type": { "type": "string", "x-aura-field-code": "tokenType" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-get-token-by-grant-type", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/realms/{realm}/protocol/openid-connect/token", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/realms/{realm}/users/{userId}/credentials": { "get": { "operationId": "aurax-bff-service-dynamic-get-credentials", "tags": [ "realms" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-get-credentials", "description": "Request and response fields are declared on the routing target `get-credentials`; this entry declares none of its own.", "parameters": [ { "name": "realm", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "realm" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "keycloakUserId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": false, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 2, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "This usage type is outside the invocation layer's filtered set, so that layer applies no binding-source filter at all and every declared source is passed through.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "createdDate": { "type": "string", "format": "date-time", "x-aura-field-code": "createdDate" }, "credentialData": { "type": "string", "x-aura-field-code": "keycloakCredentialData" }, "id": { "type": "string", "x-aura-field-code": "keycloakCredentialId" }, "type": { "type": "string", "x-aura-field-code": "keycloakCredentialType" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-get-credentials", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/realms/{realm}/users/{userId}/credentials", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "caching": true, "note": "Platform-provided behaviours declared on the routing target `get-credentials`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/send-sms-otp": { "post": { "operationId": "aurax-bff-service-dynamic-send-sms-otp-bpm", "tags": [ "send-sms-otp" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-send-sms-otp-bpm", "description": "Request and response fields are declared on the routing target `send-sms-otp`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "otpName": { "type": "string", "x-aura-field-code": "otpName" }, "phoneNumber": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true } }, "required": [ "otpName", "phoneNumber" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 2, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-send-sms-otp-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/send-sms-otp", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "OtpName", "declared_type": null, "nullable": false, "collection": false }, { "name": "PhoneNumber", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "SendSmsOtpDto", "payload": "SendSmsOtpDto", "collection": false, "members": [ { "name": "TransactionId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "EndDate", "declared_type": "DateTime?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/api/slip-transactions/view-receipt": { "post": { "operationId": "aurax-bff-redirect-view-receipt-by-entityrowid", "tags": [ "slip-transactions" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-view-receipt-by-entityrowid", "description": "Request and response fields are declared on the routing target `view-receipt-by-entityrowid`; this entry declares none of its own.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "entityRowId": { "type": "string", "format": "uuid", "x-aura-field-code": "entityRowId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "slipId" }, "isPdf": { "type": "boolean", "x-aura-field-code": "isPdf" }, "slipNumber": { "type": "string", "x-aura-field-code": "slipNumber" }, "transactionType": { "type": "integer", "format": "int32", "x-aura-field-code": "slipTransactionType" } } } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 5, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-view-receipt-by-entityrowid", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/slip-transactions/view-receipt", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "EntityRowId", "declared_type": null, "nullable": false, "collection": false, "documentation": { "summary": "Tablonun id bilgisini veya EKB icin BusinessKey bilgisini icerir", "source": "the service's own XML documentation comment, read from its source" } }, { "name": "SlipNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "Id", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsPdf", "declared_type": null, "nullable": true, "collection": false }, { "name": "AccountNumber", "declared_type": null, "nullable": false, "collection": false, "documentation": { "summary": "Ekb icin musteri hesap numarasi", "source": "the service's own XML documentation comment, read from its source" } } ] }, "x-aura-code-response": { "state": "declared-non-dto", "note": "The route returns `string`, a scalar rather than an object. There is no field tree below because there are no fields: the body is a JSON string. This is a complete answer read from the declaration, not a gap.", "declared_type": "string", "payload": "string" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_AURAX_34", "status": 400, "message": null, "message_available": false, "constant_name": "REQUEST_MUST_NOT_EMPTY" }, { "code": "ERR_AURAX_35", "status": 400, "message": null, "message_available": false, "constant_name": "SLIP_IS_EMPTY" } ] } } }, "/api/sms-notifications/details": { "get": { "operationId": "aurax-bff-dynamic-get-sms-notification-detail-list", "tags": [ "sms-notifications" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-sms-notification-detail-list", "description": "Request and response fields are declared on the routing target `get-sms-notification-detail-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "filterCode" }, "expression": { "type": "string", "x-aura-field-code": "expression" }, "parameters": { "type": "object", "x-aura-field-code": "filterParameters" } }, "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a collection.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-sms-notification-detail-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/sms-notifications/details", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-sms-notification-detail-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "SmsNotificationDetailDto", "collection": true, "members": [ { "name": "NotifyDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "SmsNotificationId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "TemplateDesignId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "NotificationType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "LanguageCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SmsTo", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SmsBody", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/api/sms-notifications/send": { "post": { "operationId": "aurax-bff-dynamic-send-sms", "tags": [ "sms-notifications" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-send-sms", "description": "Request and response fields are declared on the routing target `send-sms`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "blacklistFilter": { "type": "string", "x-aura-field-code": "blacklistFilter" }, "brandCode": { "type": "string", "x-aura-field-code": "brandCode" }, "broadcastMessage": { "type": "string", "x-aura-field-code": "broadcastMessage" }, "broadcastMessageParametric": { "type": "string", "x-aura-field-code": "broadcastMessageParametric" }, "bwFilter": { "type": "string", "x-aura-field-code": "bwFilter" }, "channel": { "type": "string", "x-aura-field-code": "channel" }, "domesticFilter": { "type": "string", "x-aura-field-code": "domesticFilter" }, "exclusionStartTime": { "type": "string", "x-aura-field-code": "exclusionStartTime" }, "exclusionexPiretime": { "type": "string", "x-aura-field-code": "exclusionexPiretime" }, "expireDate": { "type": "string", "format": "date-time", "x-aura-field-code": "expireDate" }, "forceEnglish": { "type": "string", "x-aura-field-code": "forceEnglish" }, "iysCode": { "type": "string", "x-aura-field-code": "iysCode" }, "iysFilter": { "type": "string", "x-aura-field-code": "iysFilter" }, "mnpCheckinDay": { "type": "string", "x-aura-field-code": "mnpCheckinDay" }, "multiChannelType": { "type": "string", "x-aura-field-code": "sendSmsMultiChannelType" }, "multiChannels": { "type": "array", "items": { "type": "string", "x-aura-field-code": "multiChannels" } }, "multiOriginators": { "type": "array", "items": { "type": "string", "x-aura-field-code": "multiOriginators" } }, "multiPart": { "type": "string", "x-aura-field-code": "multiPart" }, "originator": { "type": "string", "x-aura-field-code": "originator" }, "origpId": { "type": "string", "x-aura-field-code": "origpId" }, "realTime": { "type": "string", "x-aura-field-code": "realTime" }, "recipientType": { "type": "string", "x-aura-field-code": "recipientType" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "retailerCode": { "type": "string", "x-aura-field-code": "retailerCode" }, "sequence": { "type": "string", "x-aura-field-code": "sendSmsSequence" }, "simCheckinDay": { "type": "string", "x-aura-field-code": "simCheckinDay" }, "smsMessages": { "type": "array", "items": { "type": "object", "properties": { "gsmNumber": { "type": "string", "x-aura-field-code": "gsmNumber" }, "messageHeader": { "type": "string", "x-aura-field-code": "messageHeader" }, "messageId": { "type": "string", "x-aura-field-code": "messageId" }, "messageParams": { "type": "array", "items": { "type": "string", "x-aura-field-code": "messageParams" } }, "messageText": { "type": "string", "x-aura-field-code": "messageText" }, "messageType": { "type": "string", "x-aura-field-code": "messageType" } }, "required": [ "gsmNumber", "messageText" ], "x-aura-field-code": "smsMessages" } }, "startDate": { "type": "string", "format": "date-time", "x-aura-field-code": "startDate" }, "state": { "type": "integer", "format": "int32", "x-aura-field-code": "state" }, "totalCount": { "type": "string", "x-aura-field-code": "sendSmsTotalCount" }, "x": { "type": "string", "x-aura-field-code": "sendSmsX" } }, "required": [ "smsMessages" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 31, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "responseCode": { "type": "string", "x-aura-field-code": "responseCode" }, "responseGroupIdArray": { "type": "array", "items": { "type": "object", "properties": { "gsmNumber": { "type": "string", "x-aura-field-code": "gsmNumber" }, "messageid": { "type": "string", "x-aura-field-code": "messageId" }, "smsId": { "type": "string", "format": "uuid", "x-aura-field-code": "smsId" }, "smsTo": { "type": "string", "x-aura-field-code": "smsTo" }, "status": { "type": "string", "x-aura-field-code": "smsReportStatus" } }, "x-aura-field-code": "responseGroupIdArray" } }, "responseMessage": { "type": "string", "x-aura-field-code": "responseMessage" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "responseCode": { "type": "string", "x-aura-field-code": "responseCode" }, "responseGroupIdArray": { "type": "array", "items": { "type": "object", "properties": { "gsmNumber": { "type": "string", "x-aura-field-code": "gsmNumber" }, "messageid": { "type": "string", "x-aura-field-code": "messageId" }, "smsId": { "type": "string", "format": "uuid", "x-aura-field-code": "smsId" }, "smsTo": { "type": "string", "x-aura-field-code": "smsTo" }, "status": { "type": "string", "x-aura-field-code": "smsReportStatus" } }, "x-aura-field-code": "responseGroupIdArray" } }, "responseMessage": { "type": "string", "x-aura-field-code": "responseMessage" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "responseCode": { "type": "string", "x-aura-field-code": "responseCode" }, "responseGroupIdArray": { "type": "array", "items": { "type": "object", "properties": { "gsmNumber": { "type": "string", "x-aura-field-code": "gsmNumber" }, "messageid": { "type": "string", "x-aura-field-code": "messageId" }, "smsId": { "type": "string", "format": "uuid", "x-aura-field-code": "smsId" }, "smsTo": { "type": "string", "x-aura-field-code": "smsTo" }, "status": { "type": "string", "x-aura-field-code": "smsReportStatus" } }, "x-aura-field-code": "responseGroupIdArray" } }, "responseMessage": { "type": "string", "x-aura-field-code": "responseMessage" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-send-sms", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/sms-notifications/send", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "unresolved", "note": "The repository declares `SendSmsResultDto` 2 times and nothing in the route expression says which one. No structure is published rather than one picked at random.", "declared_type": "SendSmsResultDto", "payload": "SendSmsResultDto" } } }, "/api/template-types/designs/create-document-by-code/{templateDesignCode}": { "post": { "operationId": "aurax-bff-dynamic-create-document-by-code-with-template-bpmn", "tags": [ "template-types" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "Creates document based on defined template with code", "description": "Invokes the `aurax-bff-dynamic-create-document-by-code-with-template-bpmn` service definition through `POST /api/template-types/designs/create-document-by-code/{templateDesignCode}`.\n\nRequest and response fields are declared on the routing target `create-document-by-code-with-template`; this entry declares none of its own.", "parameters": [ { "name": "templateDesignCode", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "templateDesignCode" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "designVariables": { "type": "object", "x-aura-field-code": "designVariables" }, "isResponseClear": { "type": "boolean", "x-aura-field-code": "isResponseClear" }, "languageCode": { "type": "string", "x-aura-field-code": "languageCode" } } } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 3, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-create-document-by-code-with-template-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/template-types/designs/create-document-by-code/{templateDesignCode}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "structure", "declared_type": "CreateDocumentDto", "payload": "CreateDocumentDto", "collection": false, "members": [ { "name": "TemplateDesignCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ContextVersion", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DocumentContext", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TemplateDesignContextId", "declared_type": "Guid?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/api/template-types/designs/create-document/{templateDesignId}": { "post": { "operationId": "aurax-bff-dynamic-create-document-with-template-bpmn", "tags": [ "template-types" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "creates document", "description": "Invokes the `aurax-bff-dynamic-create-document-with-template-bpmn` service definition through `POST /api/template-types/designs/create-document/{templateDesignId}`.\n\nRequest and response fields are declared on the routing target `create-document-with-template-bpmn`; this entry declares none of its own.", "parameters": [ { "name": "templateDesignId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "templateDesignId" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "designVariables": { "type": "object", "x-aura-field-code": "designVariables" }, "isResponseClear": { "type": "boolean", "x-aura-field-code": "isResponseClear" }, "languageCode": { "type": "string", "x-aura-field-code": "languageCode" }, "templateDesignContextId": { "type": "string", "format": "uuid", "x-aura-field-code": "templateDesignContextId" } } } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 4, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "contextVersion": { "type": "number", "format": "decimal", "x-aura-field-code": "contextVersion" }, "documentContext": { "type": "string", "x-aura-field-code": "documentContext" }, "templateDesignCode": { "type": "string", "x-aura-field-code": "templateDesignCode" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "contextVersion": { "type": "number", "format": "decimal", "x-aura-field-code": "contextVersion" }, "documentContext": { "type": "string", "x-aura-field-code": "documentContext" }, "templateDesignCode": { "type": "string", "x-aura-field-code": "templateDesignCode" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "contextVersion": { "type": "number", "format": "decimal", "x-aura-field-code": "contextVersion" }, "documentContext": { "type": "string", "x-aura-field-code": "documentContext" }, "templateDesignCode": { "type": "string", "x-aura-field-code": "templateDesignCode" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-create-document-with-template-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/template-types/designs/create-document/{templateDesignId}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "TemplateDesignId", "declared_type": null, "nullable": false, "collection": false }, { "name": "LanguageCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "DesignVariables", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsResponseClear", "declared_type": null, "nullable": true, "collection": false }, { "name": "TemplateDesignContextId", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsPdf", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/throw-distirubted-events-bpm": { "post": { "operationId": "aurax-bff-dynamic-throw-distirubted-events-bpm", "tags": [ "throw-distirubted-events-bpm" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "throw-distirubted-events-bpm", "description": "Invokes the `aurax-bff-dynamic-throw-distirubted-events-bpm` service definition through `POST /api/throw-distirubted-events-bpm`.\n\nRequest and response fields are declared on the routing target `throw-distirubted-events-bpm`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" } }, "required": [ "customerId" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-throw-distirubted-events-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/throw-distirubted-events-bpm", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/update-potential-user": { "put": { "operationId": "aurax-bff-partner-update-potential-user", "tags": [ "update-potential-user" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-partner-update-potential-user", "description": "Request and response fields are declared on the routing target `update-potential-user-bpm`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "citizenId": { "type": "string", "x-aura-field-code": "citizenId" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "phoneNumber": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true }, "userName": { "type": "string", "x-aura-field-code": "userName" } }, "required": [ "citizenId", "customerId", "phoneNumber", "userName" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 4, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-partner-update-potential-user", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/update-potential-user", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/user-notifications/last-activity": { "get": { "operationId": "aurax-bff-dynamic-get-user-notification-last-activity", "tags": [ "user-notifications" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-user-notification-last-activity", "description": "Request and response fields are declared on the routing target `get-user-notification-last-activity`; this entry declares none of its own.", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-user-notification-last-activity", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/user-notifications/last-activity", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "structure", "declared_type": "UserNotificationActivityDto", "payload": "UserNotificationActivityDto", "collection": false, "members": [ { "name": "NotificationLastReadDate", "declared_type": "DateTime?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/api/user-notifications/reset-read-date": { "post": { "operationId": "aurax-bff-dynamic-reset-user-notification-last-read-date", "tags": [ "user-notifications" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-reset-user-notification-last-read-date", "description": "Request and response fields are declared on the routing target `reset-user-notification-last-read-date`; this entry declares none of its own.", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-reset-user-notification-last-read-date", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/user-notifications/reset-read-date", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "command-id", "note": "The route returns `AuraCommandDto`, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, `Id`, of type `Guid`. A caller gets a JSON OBJECT with one field, not a bare value. The field is `id` on the wire.", "declared_type": "AuraCommandDto", "envelopes": [ "AuraCommandDto" ], "payload": "Guid", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false, "wire_name": "id", "wire_name_basis": "framework-naming-policy" } ], "naming": "Member names are the service's declaration names.", "synthesized": true } } }, "/api/user-notifications/unread-count": { "get": { "operationId": "aurax-bff-dynamic-get-user-notification-unread-count", "tags": [ "user-notifications" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-user-notification-unread-count", "description": "Request and response fields are declared on the routing target `get-user-notification-unread-count`; this entry declares none of its own.", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-user-notification-unread-count", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/user-notifications/unread-count", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "declared-non-dto", "note": "The route returns `int`, a scalar rather than an object. There is no field tree below because there are no fields: the body is a JSON number, a 32-bit integer. This is a complete answer read from the declaration, not a gap.", "declared_type": "int", "payload": "int" } } }, "/api/users/by-customer-number/{customerNumber}/authenticate": { "post": { "operationId": "aurax-bff-dynamic-authenticate-user-by-customer-number", "tags": [ "users" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "Müşteri numarasına göre kullanıcının yetkisini kontrol eder.", "description": "Invokes the `aurax-bff-dynamic-authenticate-user-by-customer-number` service definition through `POST /api/users/by-customer-number/{customerNumber}/authenticate`.\n\nRequest and response fields are declared on the routing target `aurax-bff-authenticate-user-by-customer-number`; this entry declares none of its own.", "parameters": [ { "name": "customerNumber", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "customerNumber" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "password": { "type": "string", "x-aura-field-code": "userPassword", "x-aura-encrypted": true } }, "required": [ "password" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-authenticate-user-by-customer-number", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/users/by-customer-number/{customerNumber}/authenticate", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "structure", "declared_type": "AuthenticateUserDto", "payload": "AuthenticateUserDto", "collection": false, "members": [ { "name": "IsLoggedIn", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "IsBlocked", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/api/users/by-customer-number/{customerNumber}/has-account": { "get": { "operationId": "aurax-bff-dynamic-get-user-account-control-by-customer-number", "tags": [ "users" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-user-account-control-by-customer-number", "description": "Request and response fields are declared on the routing target `aurax-bff-get-user-account-control-by-customer-number`; this entry declares none of its own.", "parameters": [ { "name": "customerNumber", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "customerNumber" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-user-account-control-by-customer-number", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/users/by-customer-number/{customerNumber}/has-account", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "structure", "declared_type": "UserAccountControlDto", "payload": "UserAccountControlDto", "collection": false, "members": [ { "name": "Result", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/api/users/by-identity-number/{identityNumber}/authenticate": { "post": { "operationId": "aurax-bff-dynamic-authenticate-user-by-identity-number", "tags": [ "users" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "Müşteri kimlik numarasına göre kullanıcının yetkisini kontrol eder.", "description": "Invokes the `aurax-bff-dynamic-authenticate-user-by-identity-number` service definition through `POST /api/users/by-identity-number/{identityNumber}/authenticate`.\n\nRequest and response fields are declared on the routing target `aurax-bff-authenticate-user-by-identity-number`; this entry declares none of its own.", "parameters": [ { "name": "identityNumber", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "password": { "type": "string", "x-aura-field-code": "userPassword", "x-aura-encrypted": true } }, "required": [ "password" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-authenticate-user-by-identity-number", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/users/by-identity-number/{identityNumber}/authenticate", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "structure", "declared_type": "AuthenticateUserDto", "payload": "AuthenticateUserDto", "collection": false, "members": [ { "name": "IsLoggedIn", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "IsBlocked", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/api/users/by-identity-number/{identityNumber}/has-account": { "get": { "operationId": "aurax-bff-dynamic-get-user-account-control-by-identity-number", "tags": [ "users" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-user-account-control-by-identity-number", "description": "Request and response fields are declared on the routing target `aurax-bff-get-user-account-control-by-identity-number`; this entry declares none of its own.", "parameters": [ { "name": "identityNumber", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-user-account-control-by-identity-number", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/users/by-identity-number/{identityNumber}/has-account", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "structure", "declared_type": "UserAccountControlDto", "payload": "UserAccountControlDto", "collection": false, "members": [ { "name": "Result", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/api/users/by-phone-number/{phoneNumber}/authenticate": { "post": { "operationId": "aurax-bff-dynamic-authenticate-user-by-phone-number", "tags": [ "users" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "Müşteri telefon numarasına göre kullanıcının yetkisini kontrol eder.", "description": "Invokes the `aurax-bff-dynamic-authenticate-user-by-phone-number` service definition through `POST /api/users/by-phone-number/{phoneNumber}/authenticate`.\n\nRequest and response fields are declared on the routing target `aurax-bff-authenticate-user-by-phone-number`; this entry declares none of its own.", "parameters": [ { "name": "phoneNumber", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "password": { "type": "string", "x-aura-field-code": "userPassword", "x-aura-encrypted": true } }, "required": [ "password" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-authenticate-user-by-phone-number", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/users/by-phone-number/{phoneNumber}/authenticate", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "structure", "declared_type": "AuthenticateUserDto", "payload": "AuthenticateUserDto", "collection": false, "members": [ { "name": "IsLoggedIn", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "IsBlocked", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/api/validate-citizenid-tax": { "post": { "operationId": "aurax-bff-service-dynamic-validate-citizenid-tax-bpm", "tags": [ "validate-citizenid-tax" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-validate-citizenid-tax-bpm", "description": "Request and response fields are declared on the routing target `validate-citizenid-tax-bpm`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "citizenidType": { "type": "integer", "format": "int32", "x-aura-field-code": "citizenidType" } }, "required": [ "citizenid", "citizenidType" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 2, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "formulaResult": { "type": "boolean", "x-aura-field-code": "formulaResult" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "formulaResult": { "type": "boolean", "x-aura-field-code": "formulaResult" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "formulaResult": { "type": "boolean", "x-aura-field-code": "formulaResult" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-validate-citizenid-tax-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/validate-citizenid-tax", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/validate-iban": { "post": { "operationId": "aurax-bff-service-dynamic-validate-iban-bpmn", "tags": [ "validate-iban" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-validate-iban-bpmn", "description": "Request and response fields are declared on the routing target `validate-iban-bpmn`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "iban": { "type": "string", "x-aura-field-code": "iban" } }, "required": [ "iban" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "accountId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountId" }, "accountNumber": { "type": "string", "x-aura-field-code": "accountNumber" }, "formulaResult": { "type": "boolean", "x-aura-field-code": "formulaResult" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "accountId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountId" }, "accountNumber": { "type": "string", "x-aura-field-code": "accountNumber" }, "formulaResult": { "type": "boolean", "x-aura-field-code": "formulaResult" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "accountId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountId" }, "accountNumber": { "type": "string", "x-aura-field-code": "accountNumber" }, "formulaResult": { "type": "boolean", "x-aura-field-code": "formulaResult" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-validate-iban-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/validate-iban", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/verify-customer": { "post": { "operationId": "aurax-bff-service-dynamic-verify-customer-bpm", "tags": [ "verify-customer" ], "summary": "aurax-bff-service-dynamic-verify-customer-bpm", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "query", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": false, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "This usage type is outside the invocation layer's filtered set, so that layer applies no binding-source filter at all and every declared source is passed through.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "addressOpenText": { "type": "string", "x-aura-field-code": "addressOpenText", "x-aura-maskable": true }, "birthPlace": { "type": "string", "x-aura-field-code": "personInfoBirthPlace" }, "building": { "type": "string", "x-aura-field-code": "building", "x-aura-maskable": true }, "city": { "type": "string", "x-aura-field-code": "city", "x-aura-maskable": true }, "district": { "type": "string", "x-aura-field-code": "district", "x-aura-maskable": true }, "name": { "type": "string", "x-aura-field-code": "personInfoName", "x-aura-maskable": true }, "neihgbourhood": { "type": "string", "x-aura-field-code": "neihgbourhood", "x-aura-maskable": true }, "referenceId": { "type": "string", "format": "uuid", "x-aura-field-code": "kycReferenceId", "x-aura-encrypted": true }, "street": { "type": "string", "x-aura-field-code": "street", "x-aura-maskable": true }, "surname": { "type": "string", "x-aura-field-code": "surname", "x-aura-maskable": true } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "addressOpenText": { "type": "string", "x-aura-field-code": "addressOpenText", "x-aura-maskable": true }, "birthPlace": { "type": "string", "x-aura-field-code": "personInfoBirthPlace" }, "building": { "type": "string", "x-aura-field-code": "building", "x-aura-maskable": true }, "city": { "type": "string", "x-aura-field-code": "city", "x-aura-maskable": true }, "district": { "type": "string", "x-aura-field-code": "district", "x-aura-maskable": true }, "name": { "type": "string", "x-aura-field-code": "personInfoName", "x-aura-maskable": true }, "neihgbourhood": { "type": "string", "x-aura-field-code": "neihgbourhood", "x-aura-maskable": true }, "referenceId": { "type": "string", "format": "uuid", "x-aura-field-code": "kycReferenceId", "x-aura-encrypted": true }, "street": { "type": "string", "x-aura-field-code": "street", "x-aura-maskable": true }, "surname": { "type": "string", "x-aura-field-code": "surname", "x-aura-maskable": true } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "addressOpenText": { "type": "string", "x-aura-field-code": "addressOpenText", "x-aura-maskable": true }, "birthPlace": { "type": "string", "x-aura-field-code": "personInfoBirthPlace" }, "building": { "type": "string", "x-aura-field-code": "building", "x-aura-maskable": true }, "city": { "type": "string", "x-aura-field-code": "city", "x-aura-maskable": true }, "district": { "type": "string", "x-aura-field-code": "district", "x-aura-maskable": true }, "name": { "type": "string", "x-aura-field-code": "personInfoName", "x-aura-maskable": true }, "neihgbourhood": { "type": "string", "x-aura-field-code": "neihgbourhood", "x-aura-maskable": true }, "referenceId": { "type": "string", "format": "uuid", "x-aura-field-code": "kycReferenceId", "x-aura-encrypted": true }, "street": { "type": "string", "x-aura-field-code": "street", "x-aura-maskable": true }, "surname": { "type": "string", "x-aura-field-code": "surname", "x-aura-maskable": true } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-verify-customer-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/verify-customer", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/api/verify-otp-and-create-potential-user-bpm": { "post": { "operationId": "aurax-bff-partner-verify-otp-and-create-potential-user", "tags": [ "verify-otp-and-create-potential-user-bpm" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-partner-verify-otp-and-create-potential-user", "description": "Request and response fields are declared on the routing target `verify-sms-otp-and-create-potential-user-bpm`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "citizenId": { "type": "string", "x-aura-field-code": "citizenId" }, "oneTimePassword": { "type": "string", "x-aura-field-code": "oneTimePassword", "x-aura-encrypted": true }, "transactionId": { "type": "string", "format": "uuid", "x-aura-field-code": "transactionId" } }, "required": [ "citizenId", "oneTimePassword", "transactionId" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 3, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "token": { "type": "string", "x-aura-field-code": "token" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "token": { "type": "string", "x-aura-field-code": "token" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "token": { "type": "string", "x-aura-field-code": "token" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-partner-verify-otp-and-create-potential-user", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "api/verify-otp-and-create-potential-user-bpm", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/portalrove-corporate-assignment-request-bpmn": { "post": { "operationId": "aurax-bff-redirect-approve-corporate-assignment-request-bpmn", "tags": [ "approve-corporate-assignment-request-bpmn" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-approve-corporate-assignment-request-bpmn", "description": "Request and response fields are declared on the routing target `approve-corporate-assignment-request-bpmn`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "corporateAssignmentRequestId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateAssignmentRequestId" } }, "required": [ "corporateAssignmentRequestId" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "corporateAssignmentId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateAssignmentId" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "corporateAssignmentId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateAssignmentId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "corporateAssignmentId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateAssignmentId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-approve-corporate-assignment-request-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "approve-corporate-assignment-request-bpmn", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/portalroved-contacts": { "get": { "operationId": "aurax-bff-redirect-get-approved-contact-list", "tags": [ "approved-contacts" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-approved-contact-list", "description": "Request and response fields are declared on the routing target `get-approved-contact-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a collection.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-approved-contact-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "approved-contacts", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-approved-contact-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "ApprovedContactDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "PhoneNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Email", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } }, "post": { "operationId": "aurax-bff-redirect-create-approved-contact", "tags": [ "approved-contacts" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-create-approved-contact", "description": "Request and response fields are declared on the routing target `create-approved-contact`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "x-aura-field-code": "email" }, "phoneNumber": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true } }, "required": [ "email", "phoneNumber" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 2, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-approved-contact", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "approved-contacts", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PhoneNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "Email", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "command-id", "note": "The route returns `AuraCommandDto`, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, `Id`, of type `Guid`. A caller gets a JSON OBJECT with one field, not a bare value. The field is `id` on the wire.", "declared_type": "AuraCommandDto", "envelopes": [ "AuraCommandDto" ], "payload": "Guid", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false, "wire_name": "id", "wire_name_basis": "framework-naming-policy" } ], "naming": "Member names are the service's declaration names.", "synthesized": true }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_INTGRTN_62", "status": 400, "message": null, "message_available": false, "constant_name": "APPROVED_CONTACT_ALREADY_EXIST" } ] } } }, "/portalroved-contacts/by-phone-number/{phoneNumber}": { "get": { "operationId": "aurax-bff-redirect-get-approved-contact-by-phone-number", "tags": [ "approved-contacts" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-approved-contact-by-phone-number", "description": "Request and response fields are declared on the routing target `get-approved-contact-by-phone-number`; this entry declares none of its own.", "parameters": [ { "name": "phoneNumber", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-approved-contact-by-phone-number", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "approved-contacts/by-phone-number/{phoneNumber}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PhoneNumber", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ApprovedContactDto", "payload": "ApprovedContactDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "PhoneNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Email", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/portalroved-contacts/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-approved-contact", "tags": [ "approved-contacts" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-delete-approved-contact", "description": "Request and response fields are declared on the routing target `delete-approved-contact`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "x-aura-type": "unresolved" } } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-approved-contact", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "approved-contacts/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_INTGRTN_63", "status": 400, "message": null, "message_available": false, "constant_name": "APPROVED_CONTACT_NOT_FOUND" } ] } }, "get": { "operationId": "aurax-bff-redirect-get-approved-contact-by-id", "tags": [ "approved-contacts" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-approved-contact-by-id", "description": "Request and response fields are declared on the routing target `get-approved-contact-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "x-aura-type": "unresolved" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-approved-contact-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "approved-contacts/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ApprovedContactDto", "payload": "ApprovedContactDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "PhoneNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Email", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_INTGRTN_63", "status": 400, "message": null, "message_available": false, "constant_name": "APPROVED_CONTACT_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-approved-contact", "tags": [ "approved-contacts" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-update-approved-contact", "description": "Request and response fields are declared on the routing target `update-approved-contact`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "x-aura-type": "unresolved" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "x-aura-field-code": "email" }, "phoneNumber": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true } }, "required": [ "email", "phoneNumber" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 2, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-approved-contact", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "approved-contacts/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "PhoneNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "Email", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_INTGRTN_63", "status": 400, "message": null, "message_available": false, "constant_name": "APPROVED_CONTACT_NOT_FOUND" } ] } } }, "/assignments/by-customer-id/{customerId}": { "get": { "operationId": "aurax-bff-redirect-get-allotment-assignment-by-customer-id", "tags": [ "assignments" ], "summary": "aurax-bff-redirect-get-allotment-assignment-by-customer-id", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-allotment-assignment-by-customer-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "assignments/by-customer-id/{customerId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "AllotmentAssignmentDto", "collection": true, "members": [ { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "FinancialAnalysisId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "AllotmentDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "ValidityEndDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "AllotmentAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "ExternalCalculatedLimit", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "InternalCalculatedLimit", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AllotmentStatus", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Collaterals", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Comments", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Details", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Products", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-allotment-assignment-by-customer-id", "target_dapr_app_id": "allotment-service", "target_route": "assignments/by-customer-id/{customerId}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/assignments/by-customer-id/{customerId}/summary": { "get": { "operationId": "aurax-bff-redirect-get-allotment-assignment-summary-by-customer-id", "tags": [ "assignments" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-allotment-assignment-summary-by-customer-id", "description": "Request and response fields are declared on the routing target `get-allotment-assignment-summary-by-customer-id`; this entry declares none of its own.", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a collection.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-allotment-assignment-summary-by-customer-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "assignments/by-customer-id/{customerId}/summary", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "AllotmentAssignmentSummaryDto", "collection": true, "members": [ { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AllotmentAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "ExternalCalculatedLimit", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "InternalCalculatedLimit", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AllotmentStatus", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Details", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Products", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/authorized-users": { "get": { "operationId": "aurax-bff-get-authorized-user-list", "tags": [ "authorized-users" ], "summary": "aurax-bff-get-authorized-user-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-get-authorized-user-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "authorized-users", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "no-members" }, "x-aura-code-response": { "state": "declared-non-dto", "note": "The route returns `PagedResultDto`, a scalar rather than an object. There is no field tree below because there are no fields: the body is a JSON string. This is a complete answer read from the declaration, not a gap.", "declared_type": "PagedResultDto", "envelopes": [ "PagedResultDto" ], "payload": "string" } } }, "/balances": { "get": { "operationId": "aurax-bff-redirect-get-account-balance", "tags": [ "balances" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-account-balance", "description": "Request and response fields are declared on the routing target `get-account-balance`; this entry declares none of its own.", "parameters": [ { "name": "accounts", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "x-aura-field-code": "accountNumbers" } } }, { "name": "currencyId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyId" } }, { "name": "date", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "x-aura-field-code": "date" } }, { "name": "ledgerCode", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "ledgerCode" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 4 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "balances": { "type": "array", "items": { "type": "object", "properties": { "accountNumber": { "type": "string", "x-aura-field-code": "accountNumber" }, "creditBalance": { "type": "number", "format": "decimal", "x-aura-field-code": "creditBalance" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "debitBalance": { "type": "number", "format": "decimal", "x-aura-field-code": "debitBalance" }, "glCode": { "type": "string", "x-aura-field-code": "glCode" }, "totalBalance": { "type": "number", "format": "decimal", "x-aura-field-code": "totalBalance" } }, "x-aura-field-code": "balances" } }, "transactionDate": { "type": "string", "format": "date", "x-aura-field-code": "balanceDate" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-account-balance", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "balances", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Date", "declared_type": null, "nullable": true, "collection": false }, { "name": "LedgerCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "CurrencyId", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "GLAccountBalanceDto", "payload": "GLAccountBalanceDto", "collection": false, "members": [ { "name": "TransactionDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "Balances", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_190", "status": 400, "message": { "ar": "غير مسموح بالاستعلام عن رصيد مؤجل لمزيد من التاريخ.", "en": "It is not allowed to query a future dated balance.", "tr": "İleri tarihli bakiye sorgulamaya izin verilmez." }, "message_available": true, "constant_name": "DATE_CANNOT_BE_GREATER_THAN_TODAY" } ] } } }, "/base-prices": { "get": { "operationId": "aurax-bff-redirect-get-base-price-list", "tags": [ "base-prices" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-base-price-list", "description": "Request and response fields are declared on the routing target `get-base-price-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "code" } }, "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a collection.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-base-price-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "base-prices", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-base-price-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "BasePriceDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Rate", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "CurrencyId", "declared_type": "int", "nullable": false, "collection": false }, { "name": "TermType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "StartDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "EndDate", "declared_type": "DateOnly?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } }, "post": { "operationId": "aurax-bff-redirect-create-base-price", "tags": [ "base-prices" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-create-base-price", "description": "Request and response fields are declared on the routing target `create-base-price`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "code" }, "currencyId": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyId" }, "description": { "type": "string", "x-aura-field-code": "description" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "name": { "type": "string", "x-aura-field-code": "name", "x-aura-maskable": true }, "rate": { "type": "number", "format": "decimal", "x-aura-field-code": "rate" }, "startDate": { "type": "string", "format": "date-time", "x-aura-field-code": "startDate" }, "termType": { "type": "integer", "format": "int32", "x-aura-field-code": "termType" } }, "required": [ "code", "currencyId", "description", "endDate", "name", "rate", "startDate", "termType" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 8, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-base-price", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "base-prices", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Code", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "Rate", "declared_type": null, "nullable": false, "collection": false }, { "name": "CurrencyId", "declared_type": null, "nullable": false, "collection": false }, { "name": "TermType", "declared_type": null, "nullable": false, "collection": false }, { "name": "StartDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "EndDate", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "command-id", "note": "The route returns `AuraCommandDto`, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, `Id`, of type `Guid`. A caller gets a JSON OBJECT with one field, not a bare value. The field is `id` on the wire.", "declared_type": "AuraCommandDto", "envelopes": [ "AuraCommandDto" ], "payload": "Guid", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false, "wire_name": "id", "wire_name_basis": "framework-naming-policy" } ], "naming": "Member names are the service's declaration names.", "synthesized": true }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_PRICING_6", "status": 400, "message": null, "message_available": false, "constant_name": "BASE_PRICE_ALREADY_EXISTS" } ] } } }, "/base-prices/by-term-type/{termType}": { "get": { "operationId": "aurax-bff-redirect-get-base-price-list-by-term-type", "tags": [ "base-prices" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-base-price-list-by-term-type", "description": "Request and response fields are declared on the routing target `get-base-price-list-by-term-type`; this entry declares none of its own.", "parameters": [ { "name": "termType", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "termType" } }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "code" } }, "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a collection.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-base-price-list-by-term-type", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "base-prices/by-term-type/{termType}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "TermType", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "BasePriceDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Rate", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "CurrencyId", "declared_type": "int", "nullable": false, "collection": false }, { "name": "TermType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "StartDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "EndDate", "declared_type": "DateOnly?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/base-prices/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-base-price", "tags": [ "base-prices" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-delete-base-price", "description": "Request and response fields are declared on the routing target `delete-base-price`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-base-price", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "base-prices/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_PRICING_5", "status": 400, "message": null, "message_available": false, "constant_name": "BASE_PRICE_NOT_FOUND" } ] } }, "get": { "operationId": "aurax-bff-redirect-get-base-price-by-id", "tags": [ "base-prices" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-base-price-by-id", "description": "Request and response fields are declared on the routing target `get-base-price-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "code" }, "currencyId": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyId" }, "description": { "type": "string", "x-aura-field-code": "description" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "name": { "type": "string", "x-aura-field-code": "name", "x-aura-maskable": true }, "rate": { "type": "number", "format": "decimal", "x-aura-field-code": "rate" }, "startDate": { "type": "string", "format": "date-time", "x-aura-field-code": "startDate" }, "termType": { "type": "integer", "format": "int32", "x-aura-field-code": "termType" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-base-price-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "base-prices/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "BasePriceDto", "payload": "BasePriceDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Rate", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "CurrencyId", "declared_type": "int", "nullable": false, "collection": false }, { "name": "TermType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "StartDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "EndDate", "declared_type": "DateOnly?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_PRICING_5", "status": 400, "message": null, "message_available": false, "constant_name": "BASE_PRICE_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-base-price", "tags": [ "base-prices" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-update-base-price", "description": "Request and response fields are declared on the routing target `update-base-price`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "code" }, "currencyId": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyId" }, "description": { "type": "string", "x-aura-field-code": "description" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "name": { "type": "string", "x-aura-field-code": "name", "x-aura-maskable": true }, "rate": { "type": "number", "format": "decimal", "x-aura-field-code": "rate" }, "startDate": { "type": "string", "format": "date-time", "x-aura-field-code": "startDate" }, "termType": { "type": "integer", "format": "int32", "x-aura-field-code": "termType" } }, "required": [ "code", "currencyId", "description", "endDate", "name", "rate", "startDate", "termType" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 8, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-base-price", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "base-prices/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Code", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "Rate", "declared_type": null, "nullable": false, "collection": false }, { "name": "CurrencyId", "declared_type": null, "nullable": false, "collection": false }, { "name": "TermType", "declared_type": null, "nullable": false, "collection": false }, { "name": "StartDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "EndDate", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "UpdateBasePriceDto", "payload": "UpdateBasePriceDto", "collection": false, "members": [ { "name": "IsChanged", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_PRICING_5", "status": 400, "message": null, "message_available": false, "constant_name": "BASE_PRICE_NOT_FOUND" }, { "code": "ERR_PRICING_6", "status": 400, "message": null, "message_available": false, "constant_name": "BASE_PRICE_ALREADY_EXISTS" } ] } } }, "/batch-accounting-entries/by-file-id/{batchAccountingEntryFileId}": { "get": { "operationId": "aurax-bff-redirect-get-batch-accounting-entry-list", "tags": [ "batch-accounting-entries" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-batch-accounting-entry-list", "description": "Request and response fields are declared on the routing target `get-batch-accounting-entry-list`; this entry declares none of its own.", "parameters": [ { "name": "batchAccountingEntryFileId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "batchAccountingEntryFileId" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 4 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "accountingEntryId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryId" }, "batchAccountingEntryDetails": { "type": "array", "items": { "type": "object", "properties": { "accountNumber": { "type": "string", "x-aura-field-code": "accountNumber" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "currencyId": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyId" }, "description": { "type": "string", "x-aura-field-code": "accountingEntryDetailDescription" }, "entryDirection": { "type": "integer", "format": "int32", "x-aura-field-code": "entryDirection" }, "exchangeRate": { "type": "number", "format": "decimal", "x-aura-field-code": "exchangeRate" }, "exchangeSpreadType": { "type": "integer", "format": "int32", "x-aura-field-code": "exchangeSpreadType" }, "glCode": { "type": "string", "x-aura-field-code": "glCode" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "batchAccountingEntryDetailId" }, "ordinalPosition": { "type": "integer", "format": "int32", "x-aura-field-code": "ordinalPosition" }, "organizationCode": { "type": "string", "x-aura-field-code": "organizationCode" } }, "x-aura-field-code": "batchAccountingEntryDetails" } }, "description": { "type": "string", "x-aura-field-code": "accountingEntryDescription" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "batchAccountingEntryId" }, "orderNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "batchAccountingorderNumber" }, "processResult": { "type": "string", "x-aura-field-code": "batchAccountingProcessResult" }, "processStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "batchAccountingProcessStatus" }, "transactionDate": { "type": "string", "format": "date", "x-aura-field-code": "transactionDate" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-batch-accounting-entry-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "batch-accounting-entries/by-file-id/{batchAccountingEntryFileId}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-batch-accounting-entry-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "BatchAccountingEntryFileId", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "BatchAccountingEntryDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "OrderNumber", "declared_type": "int", "nullable": false, "collection": false }, { "name": "TransactionDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "ProcessStatus", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ProcessResult", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AccountingEntryId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "BatchAccountingEntryDetails", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." } } }, "/batch-accounting-entry-files": { "get": { "operationId": "aurax-bff-redirect-get-batch-accounting-entry-file-list", "tags": [ "batch-accounting-entry-files" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-batch-accounting-entry-file-list", "description": "Request and response fields are declared on the routing target `get-batch-accounting-entry-file-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "createdDate": { "type": "string", "format": "date-time", "x-aura-field-code": "createdDate" }, "fileName": { "type": "string", "x-aura-field-code": "fileName" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "batchAccountingEntryFileId" }, "userCode": { "type": "string", "x-aura-field-code": "userCode" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-batch-accounting-entry-file-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "batch-accounting-entry-files", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-batch-accounting-entry-file-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "BatchAccountingEntryFileDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "FileName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UserCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CreatedDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "BatchAccountingEntrys", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." } }, "post": { "operationId": "aurax-bff-redirect-create-batch-accounting-entry-bpmn", "tags": [ "batch-accounting-entry-files" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-create-batch-accounting-entry-bpmn", "description": "Request and response fields are declared on the routing target `create-batch-accounting-entry-bpmn`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "accountingEntryList": { "type": "array", "items": { "type": "object", "properties": { "accountingEntryDetails": { "type": "array", "items": { "type": "object", "properties": { "accountNumber": { "type": "string", "x-aura-field-code": "accountNumber" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "description": { "type": "string", "x-aura-field-code": "accountingEntryDetailDescription" }, "entryDirection": { "type": "integer", "format": "int32", "x-aura-field-code": "entryDirection" }, "exchangeRate": { "type": "number", "format": "decimal", "x-aura-field-code": "exchangeRate" }, "exchangeSpreadType": { "type": "integer", "format": "int32", "x-aura-field-code": "exchangeSpreadType" }, "glCode": { "type": "string", "x-aura-field-code": "glCode" }, "ordinalPosition": { "type": "integer", "format": "int32", "x-aura-field-code": "ordinalPosition" }, "organizationCode": { "type": "string", "x-aura-field-code": "organizationCode" } }, "required": [ "accountNumber", "amount", "currencyNumber", "description", "entryDirection", "exchangeRate", "exchangeSpreadType", "glCode", "ordinalPosition", "organizationCode" ], "x-aura-field-code": "accountingEntryDetails" } }, "description": { "type": "string", "x-aura-field-code": "accountingEntryDescription" }, "orderNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "batchAccountingorderNumber" }, "transactionDate": { "type": "string", "format": "date", "x-aura-field-code": "transactionDate" } }, "required": [ "accountingEntryDetails", "description", "orderNumber", "transactionDate" ], "x-aura-field-code": "accountingEntryList" } }, "fileName": { "type": "string", "x-aura-field-code": "fileName" }, "isApprovalNeeded": { "type": "boolean", "x-aura-field-code": "isApprovalNeeded" }, "userCode": { "type": "string", "x-aura-field-code": "userCode" } }, "required": [ "accountingEntryList", "fileName", "userCode" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 4, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-batch-accounting-entry-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "batch-accounting-entry-files", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "FileName", "declared_type": null, "nullable": false, "collection": false }, { "name": "UserCode", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/batch-accounting-entry-files/{id}": { "get": { "operationId": "aurax-bff-redirect-get-batch-accounting-entry-file-by-id", "tags": [ "batch-accounting-entry-files" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-batch-accounting-entry-file-by-id", "description": "Request and response fields are declared on the routing target `get-batch-accounting-entry-file-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "batchAccountingEntryFileId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-batch-accounting-entry-file-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "batch-accounting-entry-files/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "BatchAccountingEntryFileDto", "payload": "BatchAccountingEntryFileDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "FileName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UserCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CreatedDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "BatchAccountingEntrys", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/batch-catalog": { "post": { "operationId": "aurax-bff-batch-catalog", "tags": [ "batch-catalog" ], "summary": "aurax-bff-batch-catalog", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "sequenceNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "sequenceNumber" }, "serviceCode": { "type": "string", "x-aura-field-code": "serviceCode" }, "variables": { "type": "object", "x-aura-field-code": "variables" } }, "required": [ "sequenceNumber", "serviceCode", "variables" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 3, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-batch-catalog", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "batch-catalog", "x-aura-request-contract": { "state": "route-claimed-by-two-repositories", "note": "Two services register this method and path, so this portal cannot say which one's request fields these would be. The fields a caller sends are exactly what would differ between them, so nothing is published rather than one of the two." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/blacklists": { "get": { "operationId": "aurax-bff-dynamic-get-black-list-list", "tags": [ "blacklists" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-black-list-list", "description": "Request and response fields are declared on the routing target `get-black-list-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "entryDescription": { "type": "string", "x-aura-field-code": "entryDescription" }, "entryReason": { "type": "integer", "format": "int32", "x-aura-field-code": "entryReason" }, "exitDescription": { "type": "string", "x-aura-field-code": "exitDescription" }, "exitReason": { "type": "integer", "format": "int32", "x-aura-field-code": "exitReason" }, "fullName": { "type": "string", "x-aura-field-code": "fullName" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "blackListId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-black-list-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "blacklists", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-black-list-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "post": { "operationId": "aurax-bff-dynamic-blacklist-create-ui-bpm", "tags": [ "blacklists" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "blacklist-create-ui-bpm", "description": "Invokes the `aurax-bff-dynamic-blacklist-create-ui-bpm` service definition through `POST /blacklists`.\n\nRequest and response fields are declared on the routing target `blacklist-create-ui-bpm`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "entryDescription": { "type": "string", "x-aura-field-code": "entryDescription" }, "entryReason": { "type": "integer", "format": "int32", "x-aura-field-code": "entryReason" }, "fullName": { "type": "string", "x-aura-field-code": "fullName" } }, "required": [ "citizenid", "entryDescription", "entryReason", "fullName" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 4, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-blacklist-create-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "blacklists", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/blacklists/by-citizenid/{citizenid}": { "get": { "operationId": "aurax-bff-dynamic-get-black-list-by-citizenid", "tags": [ "blacklists" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-black-list-by-citizenid", "description": "Request and response fields are declared on the routing target `get-black-list-by-citizenid`; this entry declares none of its own.", "parameters": [ { "name": "citizenid", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true } }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "entryDescription": { "type": "string", "x-aura-field-code": "entryDescription" }, "entryReason": { "type": "integer", "format": "int32", "x-aura-field-code": "entryReason" }, "exitDescription": { "type": "string", "x-aura-field-code": "exitDescription" }, "exitReason": { "type": "integer", "format": "int32", "x-aura-field-code": "exitReason" }, "fullName": { "type": "string", "x-aura-field-code": "fullName" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "blackListId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-black-list-by-citizenid", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "blacklists/by-citizenid/{citizenid}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-black-list-by-citizenid`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/blacklists/{id}": { "get": { "operationId": "aurax-bff-dynamic-get-black-list-by-id", "tags": [ "blacklists" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-black-list-by-id", "description": "Request and response fields are declared on the routing target `get-black-list-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "blackListId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "entryDescription": { "type": "string", "x-aura-field-code": "entryDescription" }, "entryReason": { "type": "integer", "format": "int32", "x-aura-field-code": "entryReason" }, "exitDescription": { "type": "string", "x-aura-field-code": "exitDescription" }, "exitReason": { "type": "integer", "format": "int32", "x-aura-field-code": "exitReason" }, "fullName": { "type": "string", "x-aura-field-code": "fullName" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "blackListId" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-black-list-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "blacklists/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "put": { "operationId": "aurax-bff-dynamic-blacklist-edit-ui-bpm", "tags": [ "blacklists" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "blacklist-edit-ui-bpm", "description": "Invokes the `aurax-bff-dynamic-blacklist-edit-ui-bpm` service definition through `PUT /blacklists/{id}`.\n\nRequest and response fields are declared on the routing target `blacklist-edit-ui-bpm`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in this route template but not among the Route-bound fields of the routing target `blacklist-edit-ui-bpm`, whose own path is decoupled from this one.", "x-aura-source": "route-template-only-after-collapse" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "entryDescription": { "type": "string", "x-aura-field-code": "entryDescription" }, "entryReason": { "type": "integer", "format": "int32", "x-aura-field-code": "entryReason" }, "exitDescription": { "type": "string", "x-aura-field-code": "exitDescription" }, "exitReason": { "type": "integer", "format": "int32", "x-aura-field-code": "exitReason" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "blackListId" } }, "required": [ "citizenid", "exitDescription", "exitReason", "id" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 6, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-blacklist-edit-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "blacklists/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/blocked-items": { "get": { "operationId": "aurax-bff-dynamic-get-blocked-item-list", "tags": [ "blocked-items" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-blocked-item-list", "description": "Request and response fields are declared on the routing target `get-blocked-item-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "blockedContent": { "type": "integer", "format": "int32", "x-aura-field-code": "blockedContent" }, "code": { "type": "string", "x-aura-field-code": "blockedItemCode" }, "description": { "type": "string", "x-aura-field-code": "description" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "blockedItemId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "isCreditBlocked": { "type": "boolean", "x-aura-field-code": "isCreditBlocked" }, "isDebitBlocked": { "type": "boolean", "x-aura-field-code": "isDebitBlocked" }, "isDistraint": { "type": "boolean", "x-aura-field-code": "isDistraint" }, "isDoubleBlocked": { "type": "boolean", "x-aura-field-code": "isDoubleBlocked" }, "isLeafLevel": { "type": "boolean", "x-aura-field-code": "isLeafLevel" }, "isManualBlocked": { "type": "boolean", "x-aura-field-code": "isManualBlocked" }, "isManualUnblocked": { "type": "boolean", "x-aura-field-code": "isManualUnblocked" }, "isPartialBlocked": { "type": "boolean", "x-aura-field-code": "isPartialBlocked" }, "isSorted": { "type": "boolean", "x-aura-field-code": "isSorted" }, "name": { "type": "string", "x-aura-field-code": "blockedItemName" }, "parentBlockedItemId": { "type": "string", "format": "uuid", "x-aura-field-code": "parentBlockedItemId" }, "priority": { "type": "integer", "format": "int32", "x-aura-field-code": "priority" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-blocked-item-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "blocked-items", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-blocked-item-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "BlockedItemDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ParentBlockedItemId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "IsLeafLevel", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "BlockedContent", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsSorted", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "IsPartialBlocked", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "IsCreditBlocked", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "IsDebitBlocked", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "IsDoubleBlocked", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "IsManualBlocked", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "IsManualUnblocked", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "Priority", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsDistraint", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-blocked-item-list", "target_dapr_app_id": "account-service", "target_route": "blocked-items", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-dynamic-create-blocked-item-ui-bpmn", "tags": [ "blocked-items" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-create-blocked-item-ui-bpmn", "description": "Request and response fields are declared on the routing target `create-blocked-item-ui-bpmn`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "blockedContent": { "type": "integer", "format": "int32", "x-aura-field-code": "blockedContent" }, "code": { "type": "string", "x-aura-field-code": "blockedItemCode" }, "description": { "type": "string", "x-aura-field-code": "description" }, "isCreditBlocked": { "type": "boolean", "x-aura-field-code": "isCreditBlocked" }, "isDebitBlocked": { "type": "boolean", "x-aura-field-code": "isDebitBlocked" }, "isDoubleBlocked": { "type": "boolean", "x-aura-field-code": "isDoubleBlocked" }, "isManualBlocked": { "type": "boolean", "x-aura-field-code": "isManualBlocked" }, "isManualUnblocked": { "type": "boolean", "x-aura-field-code": "isManualUnblocked" }, "isPartialBlocked": { "type": "boolean", "x-aura-field-code": "isPartialBlocked" }, "isSorted": { "type": "boolean", "x-aura-field-code": "isSorted" }, "name": { "type": "string", "x-aura-field-code": "blockedItemName" }, "parentBlockedItemId": { "type": "string", "format": "uuid", "x-aura-field-code": "parentBlockedItemId" }, "priority": { "type": "integer", "format": "int32", "x-aura-field-code": "priority" } }, "required": [ "blockedContent", "code", "description", "isCreditBlocked", "isDebitBlocked", "isDoubleBlocked", "isManualBlocked", "isManualUnblocked", "isPartialBlocked", "isSorted", "name" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 13, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-create-blocked-item-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "blocked-items", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/blocked-items/{id}": { "get": { "operationId": "aurax-bff-dynamic-get-blocked-item-by-id", "tags": [ "blocked-items" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-blocked-item-by-id", "description": "Request and response fields are declared on the routing target `get-blocked-item-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "blockedItemId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "blockedContent": { "type": "integer", "format": "int32", "x-aura-field-code": "blockedContent" }, "code": { "type": "string", "x-aura-field-code": "blockedItemCode" }, "description": { "type": "string", "x-aura-field-code": "description" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "blockedItemId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "isCreditBlocked": { "type": "boolean", "x-aura-field-code": "isCreditBlocked" }, "isDebitBlocked": { "type": "boolean", "x-aura-field-code": "isDebitBlocked" }, "isDistraint": { "type": "boolean", "x-aura-field-code": "isDistraint" }, "isDoubleBlocked": { "type": "boolean", "x-aura-field-code": "isDoubleBlocked" }, "isLeafLevel": { "type": "boolean", "x-aura-field-code": "isLeafLevel" }, "isManualBlocked": { "type": "boolean", "x-aura-field-code": "isManualBlocked" }, "isManualUnblocked": { "type": "boolean", "x-aura-field-code": "isManualUnblocked" }, "isPartialBlocked": { "type": "boolean", "x-aura-field-code": "isPartialBlocked" }, "isSorted": { "type": "boolean", "x-aura-field-code": "isSorted" }, "name": { "type": "string", "x-aura-field-code": "blockedItemName" }, "parentBlockedItemId": { "type": "string", "format": "uuid", "x-aura-field-code": "parentBlockedItemId" }, "parentId": { "type": "string", "format": "uuid", "x-aura-field-code": "parentId" }, "priority": { "type": "integer", "format": "int32", "x-aura-field-code": "priority" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-blocked-item-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "blocked-items/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "BlockedItemDto", "payload": "BlockedItemDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ParentBlockedItemId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "IsLeafLevel", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "BlockedContent", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsSorted", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "IsPartialBlocked", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "IsCreditBlocked", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "IsDebitBlocked", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "IsDoubleBlocked", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "IsManualBlocked", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "IsManualUnblocked", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "Priority", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsDistraint", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-blocked-item-by-id", "target_dapr_app_id": "account-service", "target_route": "blocked-items/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCNT_24", "status": 400, "message": { "ar": "عنصر محظور غير موجود.", "en": "Blocked item not found.", "tr": "Bloke öğesi bulunamadı." }, "message_available": true, "constant_name": "BLOCKED_ITEM_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-dynamic-update-blocked-item-ui-bpmn", "tags": [ "blocked-items" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-update-blocked-item-ui-bpmn", "description": "Request and response fields are declared on the routing target `update-blocked-item-ui-bpmn`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "blockedContent": { "type": "integer", "format": "int32", "x-aura-field-code": "blockedContent" }, "description": { "type": "string", "x-aura-field-code": "description" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "isCreditBlocked": { "type": "boolean", "x-aura-field-code": "isCreditBlocked" }, "isDebitBlocked": { "type": "boolean", "x-aura-field-code": "isDebitBlocked" }, "isDoubleBlocked": { "type": "boolean", "x-aura-field-code": "isDoubleBlocked" }, "isManualBlocked": { "type": "boolean", "x-aura-field-code": "isManualBlocked" }, "isManualUnblocked": { "type": "boolean", "x-aura-field-code": "isManualUnblocked" }, "isPartialBlocked": { "type": "boolean", "x-aura-field-code": "isPartialBlocked" }, "isSorted": { "type": "boolean", "x-aura-field-code": "isSorted" }, "name": { "type": "string", "x-aura-field-code": "blockedItemName" }, "parentBlockedItemId": { "type": "string", "format": "uuid", "x-aura-field-code": "parentBlockedItemId" }, "priority": { "type": "integer", "format": "int32", "x-aura-field-code": "priority" } }, "required": [ "blockedContent", "description", "isActive", "isCreditBlocked", "isDebitBlocked", "isDoubleBlocked", "isManualBlocked", "isManualUnblocked", "isPartialBlocked", "isSorted", "name" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 13, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-update-blocked-item-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "blocked-items/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/business-core/key-formats": { "get": { "operationId": "aurax-bff-redirect-businesscore-get-key-format-list", "tags": [ "business-core" ], "summary": "aurax-bff-redirect-businesscore-get-key-format-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-businesscore-get-key-format-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "business-core/key-formats", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/business-field-definitions": { "get": { "operationId": "aurax-bff-redirect-get-business-field-definition-list", "tags": [ "business-field-definitions" ], "summary": "aurax-bff-redirect-get-business-field-definition-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-business-field-definition-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "business-field-definitions", "x-aura-capabilities": { "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Filter", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "BusinessFieldDefinitionDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DataType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ParameterCode", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-business-field-definition-list", "target_dapr_app_id": "business-core-service", "target_route": "business-field-definitions", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/caches/keys": { "get": { "operationId": "aurax-bff-aurax-bff-get-cache-key-list", "tags": [ "caches" ], "summary": "aurax-bff-aurax-bff-get-cache-key-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-aurax-bff-get-cache-key-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "caches/keys", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "DaprAppId", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "CacheKeyDto", "collection": true, "members": [ { "name": "Key", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsSharedBetweenApplications", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "Mode", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/caches/refresh": { "post": { "operationId": "aurax-bff-aurax-bff-refresh-cache", "tags": [ "caches" ], "summary": "aurax-bff-aurax-bff-refresh-cache", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-aurax-bff-refresh-cache", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "caches/refresh", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "DaprAppId", "declared_type": null, "nullable": false, "collection": false }, { "name": "Key", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "RefreshCacheDto", "collection": true, "members": [ { "name": "Key", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsSuccess", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/calculate-customer-current-total-loan-debt-restructure-bpmn": { "post": { "operationId": "aurax-bff-calculate-customer-current-total-loan-debt-restructure-bpmn", "tags": [ "calculate-customer-current-total-loan-debt-restructure-bpmn" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-calculate-customer-current-total-loan-debt-restructure-bpmn", "description": "Request and response fields are declared on the routing target `calculate-customer-current-total-loan-debt-restructure-bpmn`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "loanId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanId" } }, "required": [ "loanId" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "customerCurrentTotalLoanDebt": { "type": "number", "format": "decimal", "x-aura-field-code": "customerCurrentTotalLoanDebt" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "customerCurrentTotalLoanDebt": { "type": "number", "format": "decimal", "x-aura-field-code": "customerCurrentTotalLoanDebt" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "customerCurrentTotalLoanDebt": { "type": "number", "format": "decimal", "x-aura-field-code": "customerCurrentTotalLoanDebt" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-calculate-customer-current-total-loan-debt-restructure-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "calculate-customer-current-total-loan-debt-restructure-bpmn", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/calculate-variable-intereset-recalculate-payback-plan-bpmn": { "post": { "operationId": "aurax-bff-redirect-calculate-variable-intereset-recalculate-payback-plan-bpmn", "tags": [ "calculate-variable-intereset-recalculate-payback-plan-bpmn" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-calculate-variable-intereset-recalculate-payback-plan-bpmn", "description": "Request and response fields are declared on the routing target `calculate-variable-intereset-recalculate-payback-plan-bpmn`; this entry declares none of its own.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "effectiveDate": { "type": "string", "x-aura-field-code": "effectiveDate" } } } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-calculate-variable-intereset-recalculate-payback-plan-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "calculate-variable-intereset-recalculate-payback-plan-bpmn", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/calendar-dimensions": { "get": { "operationId": "aurax-bff-redirect-get-calendar-dimension-list", "tags": [ "calendar-dimensions" ], "summary": "aurax-bff-redirect-get-calendar-dimension-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-calendar-dimension-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "calendar-dimensions", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "CalendarDimensionDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CountryId", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-calendar-dimension-list", "target_dapr_app_id": "business-core-service", "target_route": "calendar-dimensions", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-calendar-dimension", "tags": [ "calendar-dimensions" ], "summary": "aurax-bff-redirect-create-calendar-dimension", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-calendar-dimension", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "calendar-dimensions", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CountryId", "declared_type": null, "nullable": true, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/calendar-dimensions/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-calendar-dimension", "tags": [ "calendar-dimensions" ], "summary": "aurax-bff-redirect-delete-calendar-dimension", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-calendar-dimension", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "calendar-dimensions/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "get": { "operationId": "aurax-bff-redirect-get-calendar-dimension-by-id", "tags": [ "calendar-dimensions" ], "summary": "aurax-bff-redirect-get-calendar-dimension-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-calendar-dimension-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "calendar-dimensions/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "CalendarDimensionDto", "payload": "CalendarDimensionDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CountryId", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-calendar-dimension-by-id", "target_dapr_app_id": "business-core-service", "target_route": "calendar-dimensions/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_CLNDR_9", "status": 400, "message": null, "message_available": false, "constant_name": "CALENDAR_DIMENSION_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-calendar-dimension", "tags": [ "calendar-dimensions" ], "summary": "aurax-bff-redirect-update-calendar-dimension", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-calendar-dimension", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "calendar-dimensions/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/calendars": { "get": { "operationId": "aurax-bff-redirect-get-calendar-list", "tags": [ "calendars" ], "summary": "aurax-bff-redirect-get-calendar-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-calendar-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "calendars", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Year", "declared_type": null, "nullable": true, "collection": false }, { "name": "Month", "declared_type": null, "nullable": true, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "CalendarDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CountryId", "declared_type": "int", "nullable": false, "collection": false }, { "name": "CalendarDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "WorkdayType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "StartHour", "declared_type": "TimeOnly?", "nullable": true, "collection": false }, { "name": "EndHour", "declared_type": "TimeOnly?", "nullable": true, "collection": false }, { "name": "CalendarDimensionId", "declared_type": "Guid?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-calendar-list", "target_dapr_app_id": "business-core-service", "target_route": "calendars", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-calendar", "tags": [ "calendars" ], "summary": "aurax-bff-redirect-create-calendar", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-calendar", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "calendars", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CountryId", "declared_type": null, "nullable": true, "collection": false }, { "name": "CalendarDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "WorkdayType", "declared_type": null, "nullable": false, "collection": false }, { "name": "StartHour", "declared_type": null, "nullable": true, "collection": false }, { "name": "EndHour", "declared_type": null, "nullable": true, "collection": false }, { "name": "CalendarDimensionId", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/calendars/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-calendar", "tags": [ "calendars" ], "summary": "aurax-bff-redirect-delete-calendar", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-calendar", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "calendars/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "get": { "operationId": "aurax-bff-redirect-get-calendar-by-id", "tags": [ "calendars" ], "summary": "aurax-bff-redirect-get-calendar-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-calendar-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "calendars/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "CalendarDto", "payload": "CalendarDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CountryId", "declared_type": "int", "nullable": false, "collection": false }, { "name": "CalendarDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "WorkdayType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "StartHour", "declared_type": "TimeOnly?", "nullable": true, "collection": false }, { "name": "EndHour", "declared_type": "TimeOnly?", "nullable": true, "collection": false }, { "name": "CalendarDimensionId", "declared_type": "Guid?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-calendar-by-id", "target_dapr_app_id": "business-core-service", "target_route": "calendars/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_CLNDR_6", "status": 400, "message": null, "message_available": false, "constant_name": "CALENDAR_DATE_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-calendar", "tags": [ "calendars" ], "summary": "aurax-bff-redirect-update-calendar", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-calendar", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "calendars/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "WorkdayType", "declared_type": null, "nullable": true, "collection": false }, { "name": "StartHour", "declared_type": null, "nullable": true, "collection": false }, { "name": "EndHour", "declared_type": null, "nullable": true, "collection": false }, { "name": "CalendarDimensionId", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/cash-box-reconcilation-ui": { "post": { "operationId": "aurax-bff-redirect-cash-box-reconcilation-ui", "tags": [ "cash-box-reconcilation-ui" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-cash-box-reconcilation-ui", "description": "Request and response fields are declared on the routing target `cash-box-reconcilation-ui`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "cashBoxId": { "type": "string", "format": "uuid", "x-aura-field-code": "cashBoxId" }, "description": { "type": "string", "x-aura-field-code": "cashBoxDescription" }, "isApprovalNeeded": { "type": "boolean", "x-aura-field-code": "isApprovalNeeded" }, "reconcilations": { "type": "array", "items": { "type": "object", "properties": { "balance": { "type": "number", "format": "decimal", "x-aura-field-code": "cashBoxBalance" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "denominationAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "denominationItems": { "type": "array", "items": { "type": "object", "properties": { "denominationId": { "type": "string", "format": "uuid", "x-aura-field-code": "denominationId" }, "given": { "type": "integer", "format": "int32", "x-aura-field-code": "given" }, "taken": { "type": "integer", "format": "int32", "x-aura-field-code": "taken" } }, "required": [ "denominationId", "given", "taken" ], "x-aura-field-code": "denominationItems" } }, "difference": { "type": "number", "format": "decimal", "x-aura-field-code": "difference" } }, "required": [ "balance", "currencyNumber", "denominationAmount", "denominationItems", "difference" ], "x-aura-field-code": "reconcilations" } }, "transactionDate": { "type": "string", "format": "date", "x-aura-field-code": "transactionDate" } }, "required": [ "cashBoxId", "description", "reconcilations", "transactionDate" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 5, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-cash-box-reconcilation-ui", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "cash-box-reconcilation-ui", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/cash-flow-validation": { "get": { "operationId": "aurax-bff-redirect-cash-flow-validation-bpm", "tags": [ "cash-flow-validation" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-cash-flow-validation-bpm", "description": "Request and response fields are declared on the routing target `cash-flow-validation-bpm`; this entry declares none of its own.", "parameters": [ { "name": "accountId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "accountId" } }, { "name": "cashTransactionType", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "cashTransactionType" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 2 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "isResult": { "type": "boolean", "x-aura-field-code": "isResult" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "isResult": { "type": "boolean", "x-aura-field-code": "isResult" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "isResult": { "type": "boolean", "x-aura-field-code": "isResult" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-cash-flow-validation-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "cash-flow-validation", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/cashbalance-transactions": { "get": { "operationId": "aurax-bff-redirect-get-cash-balance-transactions", "tags": [ "cashbalance-transactions" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-cash-balance-transactions", "description": "Request and response fields are declared on the routing target `get-cash-balance-transactions`; this entry declares none of its own.", "parameters": [ { "name": "cashBoxCode", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "cashBoxCode" } }, { "name": "currency", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "cashBalanceCurrency" } }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "organizationCode", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "organizationCode" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } }, { "name": "previousBalance", "in": "query", "required": false, "schema": { "type": "boolean", "x-aura-field-code": "previousBalance" } }, { "name": "transactionDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "x-aura-field-code": "cashBalanceTransactionDate" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 10 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "balance": { "type": "number", "format": "decimal", "x-aura-field-code": "balance" }, "cashBoxCode": { "type": "string", "x-aura-field-code": "cashBoxCode" }, "currency": { "type": "integer", "format": "int32", "x-aura-field-code": "cashBalanceCurrency" }, "organizationCode": { "type": "string", "x-aura-field-code": "organizationCode" }, "previousBalance": { "type": "boolean", "x-aura-field-code": "cashBalancePreviousBalance" }, "totalCredit": { "type": "number", "format": "decimal", "x-aura-field-code": "totalCredit" }, "totalDebit": { "type": "number", "format": "decimal", "x-aura-field-code": "totalDebit" }, "transactionList": { "type": "array", "items": { "type": "object", "properties": { "accountingEntryReference": { "type": "string", "x-aura-field-code": "accountingEntryReference" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "currency": { "type": "integer", "format": "int32", "x-aura-field-code": "cashBalanceCurrency" }, "description": { "type": "string", "x-aura-field-code": "cashBalanceDescription" }, "direction": { "type": "string", "x-aura-field-code": "direction" }, "transaction": { "type": "string", "x-aura-field-code": "transaction" }, "userCode": { "type": "string", "x-aura-field-code": "userCode" } }, "x-aura-field-code": "transactionList" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-cash-balance-transactions", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "cashbalance-transactions", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-cash-balance-transactions`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "CashBalanceDto", "collection": true, "members": [ { "name": "OrganizationCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CashBoxCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Currency", "declared_type": "int", "nullable": false, "collection": false }, { "name": "TotalDebit", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "TotalCredit", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "Balance", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "PreviousBalance", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "TransactionList", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." } } }, "/cashbox-reconcilation": { "get": { "operationId": "aurax-bff-redirect-get-cash-box-reconcilation-list", "tags": [ "cashbox-reconcilation" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-cash-box-reconcilation-list", "description": "Invokes the `aurax-bff-redirect-get-cash-box-reconcilation-list` service definition through `GET /cashbox-reconcilation`.\n\nRequest and response fields are declared on the routing target `get-cash-box-reconcilation-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "accountingEntryId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryId" }, "balance": { "type": "number", "format": "decimal", "x-aura-field-code": "cashBoxBalance" }, "cashBoxId": { "type": "string", "format": "uuid", "x-aura-field-code": "cashBoxId" }, "currencyId": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyId" }, "denominationAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "denominationAmount" }, "description": { "type": "string", "x-aura-field-code": "cashBoxDescription" }, "difference": { "type": "number", "format": "decimal", "x-aura-field-code": "difference" }, "transactionDate": { "type": "string", "format": "date", "x-aura-field-code": "transactionDate" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-cash-box-reconcilation-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "cashbox-reconcilation", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-cash-box-reconcilation-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "CashBoxReconcilationDto", "collection": true, "members": [ { "name": "CashBoxId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Balance", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "DenominationAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "Difference", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "AccountingEntryId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CurrencyId", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "TransactionDate", "declared_type": "DateOnly?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." } }, "post": { "operationId": "aurax-bff-redirect-create-cashbox-reconcilation", "tags": [ "cashbox-reconcilation" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-create-cashbox-reconcilation", "description": "Request and response fields are declared on the routing target `cash-box-reconcilation-ui`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "cashBoxId": { "type": "string", "format": "uuid", "x-aura-field-code": "cashBoxId" }, "description": { "type": "string", "x-aura-field-code": "cashBoxDescription" }, "isApprovalNeeded": { "type": "boolean", "x-aura-field-code": "isApprovalNeeded" }, "reconcilations": { "type": "array", "items": { "type": "object", "properties": { "balance": { "type": "number", "format": "decimal", "x-aura-field-code": "cashBoxBalance" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "denominationAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "denominationItems": { "type": "array", "items": { "type": "object", "properties": { "denominationId": { "type": "string", "format": "uuid", "x-aura-field-code": "denominationId" }, "given": { "type": "integer", "format": "int32", "x-aura-field-code": "given" }, "taken": { "type": "integer", "format": "int32", "x-aura-field-code": "taken" } }, "required": [ "denominationId", "given", "taken" ], "x-aura-field-code": "denominationItems" } }, "difference": { "type": "number", "format": "decimal", "x-aura-field-code": "difference" } }, "required": [ "balance", "currencyNumber", "denominationAmount", "denominationItems", "difference" ], "x-aura-field-code": "reconcilations" } }, "transactionDate": { "type": "string", "format": "date", "x-aura-field-code": "transactionDate" } }, "required": [ "cashBoxId", "description", "reconcilations", "transactionDate" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 5, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-cashbox-reconcilation", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "cashbox-reconcilation", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/cashbox-transfer": { "post": { "operationId": "aurax-bff-redirect-cash-box-transfer-bpmn", "tags": [ "cashbox-transfer" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-cash-box-transfer-bpmn", "description": "Request and response fields are declared on the routing target `cash-box-transfer-bpmn`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "currencyId": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyId" }, "denominationItems": { "type": "array", "items": { "type": "object", "properties": { "denominationId": { "type": "string", "format": "uuid", "x-aura-field-code": "denominationId" }, "given": { "type": "integer", "format": "int32", "x-aura-field-code": "given" }, "taken": { "type": "integer", "format": "int32", "x-aura-field-code": "taken" } }, "required": [ "denominationId" ], "x-aura-field-code": "denominationItems" } }, "description": { "type": "string", "x-aura-field-code": "description" }, "isApprovalNeeded": { "type": "boolean", "x-aura-field-code": "isApprovalNeeded" }, "receiverCashBoxId": { "type": "string", "format": "uuid", "x-aura-field-code": "receiverCashBoxId" }, "receiverUserId": { "type": "string", "format": "uuid", "x-aura-field-code": "receiverUserId" }, "senderCashBoxId": { "type": "string", "format": "uuid", "x-aura-field-code": "senderCashBoxId" }, "senderUserId": { "type": "string", "format": "uuid", "x-aura-field-code": "senderUserId" } }, "required": [ "amount", "currencyId", "denominationItems", "receiverCashBoxId", "receiverUserId", "senderCashBoxId", "senderUserId" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 9, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-cash-box-transfer-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "cashbox-transfer", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/cashs": { "get": { "operationId": "aurax-bff-redirect-get-cash-box-list", "tags": [ "cashs" ], "summary": "aurax-bff-redirect-get-cash-box-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-cash-box-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "cashs", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "CashBoxDto", "collection": true, "members": [ { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "UserMaps", "declared_type": "List", "nullable": false, "collection": true }, { "name": "CashBoxLedgers", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-cash-box-list", "target_dapr_app_id": "account-service", "target_route": "cashs", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-cash-box-ui", "tags": [ "cashs" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "create-cash-box", "description": "Invokes the `aurax-bff-redirect-create-cash-box-ui` service definition through `POST /cashs`.\n\nRequest and response fields are declared on the routing target `create-cash-box-ui`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "cashBoxCode" }, "name": { "type": "string", "x-aura-field-code": "cashBoxName" }, "userMaps": { "type": "array", "items": { "type": "object", "properties": { "assignDate": { "type": "string", "format": "date", "x-aura-field-code": "assignDate" }, "organizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "organizationId" }, "userId": { "type": "string", "format": "uuid", "x-aura-field-code": "userId" } }, "required": [ "assignDate", "organizationId", "userId" ], "x-aura-field-code": "userMaps" } } }, "required": [ "code", "name" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 3, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-cash-box-ui", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "cashs", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/cashs/user-map": { "get": { "operationId": "aurax-bff-redirect-get-cash-user-map-list", "tags": [ "cashs" ], "summary": "aurax-bff-redirect-get-cash-user-map-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-cash-user-map-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "cashs/user-map", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "CashBoxAssignmentDto", "collection": true, "members": [ { "name": "CashBoxId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "OrganizationId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "UserId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "AssignDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "ReleaseDate", "declared_type": "DateOnly?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-cash-user-map-list", "target_dapr_app_id": "account-service", "target_route": "cashs/user-map", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/cashs/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-cash-box-ui", "tags": [ "cashs" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "delete-cash-box", "description": "Invokes the `aurax-bff-redirect-delete-cash-box-ui` service definition through `DELETE /cashs/{id}`.\n\nRequest and response fields are declared on the routing target `delete-cash-box-ui`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in this route template but not among the Route-bound fields of the routing target `delete-cash-box-ui`, whose own path is decoupled from this one.", "x-aura-source": "route-template-only-after-collapse" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "cashBoxId" } }, "required": [ "id" ] } } }, "description": "The catalog declares Body-bound fields on this DELETE operation. Request bodies on DELETE have no defined semantics in HTTP; this documents the catalog, not a recommendation. Not every field below is accepted: the platform selects which of them this operation admits and drops the rest. Of the fields below, the binder does not admit `id`, which this document nevertheless marks required because the catalog declares it so.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [ "body" ], "dropped_field_names": { "body": [ "id" ] }, "dropped_mandatory_field_names": [ "id" ], "verdict": "declared-fields-not-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": "The HTTP edge in front of this operation comes in two shapes and they differ: the platform's typed route readers bind GET and DELETE from the URL and never read a body, while its untyped catalog-redirect reader collects the body whenever the request carries one. It does not change the answer above: the selection below happens after the edge, and excludes these fields either way." }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-cash-box-ui", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "cashs/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "get": { "operationId": "aurax-bff-redirect-get-cash-box-by-id", "tags": [ "cashs" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-cash-box-by-id", "description": "Request and response fields are declared on the routing target `get-cash-box-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "cashBoxId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "cashBoxLedgers": { "type": "array", "items": { "type": "object", "properties": { "cashBoxId": { "type": "string", "format": "uuid", "x-aura-field-code": "cashBoxId" }, "currencyId": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "cashBoxLedgerId" }, "ledgerCode": { "type": "string", "x-aura-field-code": "ledgerCode" } }, "x-aura-field-code": "cashBoxLedgers" } }, "code": { "type": "string", "x-aura-field-code": "cashBoxCode" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "cashBoxId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "name": { "type": "string", "x-aura-field-code": "cashBoxName" }, "userMaps": { "type": "array", "items": { "type": "object", "properties": { "assignDate": { "type": "string", "format": "date", "x-aura-field-code": "assignDate" }, "cashBoxId": { "type": "string", "format": "uuid", "x-aura-field-code": "cashBoxId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "userMapId" }, "organizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "organizationId" }, "releaseDate": { "type": "string", "format": "date", "x-aura-field-code": "releaseDate" }, "userId": { "type": "string", "format": "uuid", "x-aura-field-code": "userId" } }, "x-aura-field-code": "userMaps" } } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-cash-box-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "cashs/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "CashBoxDto", "payload": "CashBoxDto", "collection": false, "members": [ { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "UserMaps", "declared_type": "List", "nullable": false, "collection": true }, { "name": "CashBoxLedgers", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-cash-box-by-id", "target_dapr_app_id": "account-service", "target_route": "cashs/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCNT_85", "status": 400, "message": { "ar": "تعريف النقد غير موجود.", "en": "Cash definition is not found.", "tr": "Nakit tanımı bulunamadı." }, "message_available": true, "constant_name": "CASH_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-cash-box-ui", "tags": [ "cashs" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "update-cash-box", "description": "Invokes the `aurax-bff-redirect-update-cash-box-ui` service definition through `PUT /cashs/{id}`.\n\nRequest and response fields are declared on the routing target `update-cash-box-ui`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in this route template but not among the Route-bound fields of the routing target `update-cash-box-ui`, whose own path is decoupled from this one.", "x-aura-source": "route-template-only-after-collapse" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "cashBoxCode" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "cashBoxId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "name": { "type": "string", "x-aura-field-code": "cashBoxName" }, "userMaps": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "assignDate": { "type": "string", "format": "date", "x-aura-field-code": "assignDate" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "userMapId" }, "organizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "organizationId" }, "releaseDate": { "type": "string", "format": "date", "x-aura-field-code": "releaseDate" }, "userId": { "type": "string", "format": "uuid", "x-aura-field-code": "userId" } }, "required": [ "_rowStatus", "assignDate", "organizationId", "userId" ], "x-aura-field-code": "userMaps" } } }, "required": [ "code", "id", "isActive", "name" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 5, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-cash-box-ui", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "cashs/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/cashs/{id}/with-user-map": { "get": { "operationId": "aurax-bff-redirect-get-cash-with-user-map", "tags": [ "cashs" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-cash-with-user-map", "description": "Request and response fields are declared on the routing target `get-cash-with-user-map`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "cashBoxId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "cashBoxLedgers": { "type": "array", "items": { "type": "object", "properties": { "cashBoxId": { "type": "string", "format": "uuid", "x-aura-field-code": "cashBoxId" }, "currencyId": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "cashBoxLedgerId" }, "ledgerCode": { "type": "string", "x-aura-field-code": "ledgerCode" } }, "x-aura-field-code": "cashBoxLedgers" } }, "code": { "type": "string", "x-aura-field-code": "cashBoxCode" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "cashBoxId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "name": { "type": "string", "x-aura-field-code": "cashBoxName" }, "userMaps": { "type": "array", "items": { "type": "object", "properties": { "assignDate": { "type": "string", "format": "date", "x-aura-field-code": "assignDate" }, "cashBoxId": { "type": "string", "format": "uuid", "x-aura-field-code": "cashBoxId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "userMapId" }, "organizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "organizationId" }, "releaseDate": { "type": "string", "format": "date", "x-aura-field-code": "releaseDate" }, "userId": { "type": "string", "format": "uuid", "x-aura-field-code": "userId" } }, "x-aura-field-code": "userMaps" } } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-cash-with-user-map", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "cashs/{id}/with-user-map", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "CashBoxDto", "payload": "CashBoxDto", "collection": false, "members": [ { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "UserMaps", "declared_type": "List", "nullable": false, "collection": true }, { "name": "CashBoxLedgers", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCNT_85", "status": 400, "message": { "ar": "تعريف النقد غير موجود.", "en": "Cash definition is not found.", "tr": "Nakit tanımı bulunamadı." }, "message_available": true, "constant_name": "CASH_NOT_FOUND" } ] } } }, "/central-bank-transaction-limits": { "get": { "operationId": "aurax-bff-redirect-get-central-bank-transaction-limit-list", "tags": [ "central-bank-transaction-limits" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-central-bank-transaction-limit-list", "description": "Request and response fields are declared on the routing target `get-central-bank-transaction-limit-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a collection.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-central-bank-transaction-limit-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "central-bank-transaction-limits", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-central-bank-transaction-limit-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "CentralBankTransactionLimitDto", "collection": true, "members": [ { "name": "LimitType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MinAmountLimit", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "MaxAmountLimit", "declared_type": "decimal", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } }, "post": { "operationId": "aurax-bff-redirect-create-central-bank-transaction-limit-bpm", "tags": [ "central-bank-transaction-limits" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-create-central-bank-transaction-limit-bpm", "description": "Request and response fields are declared on the routing target `create-central-bank-transaction-limit-bpm`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "x-aura-field-code": "centralBankTransactionLimitDescription" }, "limitType": { "type": "integer", "format": "int32", "x-aura-field-code": "limitType" }, "maxAmountLimit": { "type": "number", "format": "decimal", "x-aura-field-code": "maxAmountLimit" }, "minAmountLimit": { "type": "number", "format": "decimal", "x-aura-field-code": "minAmountLimit" } }, "required": [ "description", "limitType", "maxAmountLimit", "minAmountLimit" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 4, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-central-bank-transaction-limit-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "central-bank-transaction-limits", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "LimitType", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "MinAmountLimit", "declared_type": null, "nullable": true, "collection": false }, { "name": "MaxAmountLimit", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/central-bank-transaction-limits/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-central-bank-transaction-limit.bpm", "tags": [ "central-bank-transaction-limits" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-delete-central-bank-transaction-limit.bpm", "description": "Request and response fields are declared on the routing target `delete-central-bank-transaction-limit-bpm`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "centralBankTransactionLimitId" } } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-central-bank-transaction-limit.bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "central-bank-transaction-limits/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "get": { "operationId": "aurax-bff-redirect-get-central-bank-transaction-limit-by-id", "tags": [ "central-bank-transaction-limits" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-central-bank-transaction-limit-by-id", "description": "Request and response fields are declared on the routing target `get-central-bank-transaction-limit-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "centralBankTransactionLimitId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-central-bank-transaction-limit-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "central-bank-transaction-limits/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "CentralBankTransactionLimitDto", "payload": "CentralBankTransactionLimitDto", "collection": false, "members": [ { "name": "LimitType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MinAmountLimit", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "MaxAmountLimit", "declared_type": "decimal", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_MNYTRNS_63", "status": 400, "message": { "en": "Transaction limit is not found." }, "message_available": true, "constant_name": "LIMIT_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-central-bank-transaction-limit-bpm", "tags": [ "central-bank-transaction-limits" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-update-central-bank-transaction-limit-bpm", "description": "Request and response fields are declared on the routing target `update-central-bank-transaction-limit-bpm`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "centralBankTransactionLimitId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "x-aura-field-code": "centralBankTransactionLimitDescription" }, "limitType": { "type": "integer", "format": "int32", "x-aura-field-code": "limitType" }, "maxAmountLimit": { "type": "number", "format": "decimal", "x-aura-field-code": "maxAmountLimit" }, "minAmountLimit": { "type": "number", "format": "decimal", "x-aura-field-code": "minAmountLimit" } }, "required": [ "description", "limitType", "maxAmountLimit", "minAmountLimit" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 4, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-central-bank-transaction-limit-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "central-bank-transaction-limits/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "LimitType", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "MinAmountLimit", "declared_type": null, "nullable": true, "collection": false }, { "name": "MaxAmountLimit", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/channels": { "get": { "operationId": "aurax-bff-get-channel-list", "tags": [ "channels" ], "summary": "aurax-bff-get-channel-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a collection.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-get-channel-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "channels", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "ChannelDefinitionDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ChannelName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ChannelType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ChannelDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ChannelDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "ClientId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsShared", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "HasPartner", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "ClientSecret", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsCustomDateEnabled", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } }, "post": { "operationId": "aurax-bff-redirect-create-channel-bpmn", "tags": [ "channels" ], "summary": "aurax-bff-redirect-create-channel-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-channel-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "channels", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChannelName", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChannelType", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChannelDescription", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChannelDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "ClientId", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsShared", "declared_type": null, "nullable": false, "collection": false }, { "name": "HasPartner", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsCustomDateEnabled", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/channels/current": { "get": { "operationId": "aurax-bff-get-current-channel", "tags": [ "channels" ], "summary": "aurax-bff-get-current-channel", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-get-current-channel", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "channels/current", "x-aura-request-contract": { "state": "no-members" }, "x-aura-code-response": { "state": "structure", "declared_type": "ChannelDto", "payload": "ChannelDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ClientId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Date", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "Type", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsCustomDateEnabled", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/channels/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-channel-bpmn", "tags": [ "channels" ], "summary": "aurax-bff-redirect-delete-channel-bpmn", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-channel-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "channels/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "get": { "operationId": "aurax-bff-redirect-get-channel-definition-by-id", "tags": [ "channels" ], "summary": "aurax-bff-redirect-get-channel-definition-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-channel-definition-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "channels/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ChannelDefinitionDto", "payload": "ChannelDefinitionDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ChannelName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ChannelType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ChannelDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ChannelDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "ClientId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsShared", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "HasPartner", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "IsCustomDateEnabled", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-channel-definition-by-id", "target_dapr_app_id": "core-service", "target_route": "channels/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_CORE_125", "status": 400, "message": { "ar": "لم يتم العثور على معرف القناة.", "en": "Channel cannot be found.", "tr": "Kanal kimliği bulunamadı." }, "message_available": true, "constant_name": "CHANNEL_ID_IS_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-channel-bpmn", "tags": [ "channels" ], "summary": "aurax-bff-redirect-update-channel-bpmn", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-channel-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "channels/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChannelType", "declared_type": null, "nullable": true, "collection": false }, { "name": "ChannelDescription", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChannelDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsShared", "declared_type": null, "nullable": false, "collection": false }, { "name": "HasPartner", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsCustomDateEnabled", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/client-logs": { "get": { "operationId": "aurax-bff-redirect-aurax-management-get-client-log-list", "tags": [ "client-logs" ], "summary": "aurax-bff-redirect-aurax-management-get-client-log-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-aurax-management-get-client-log-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "client-logs", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "ClientLogDto", "collection": true, "members": [ { "name": "ClientDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "TransactionDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "UrlPath", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LanguageCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UserCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ClientIp", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ClientDeviceDetail", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ErrorMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FormDefinitionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ErrorStack", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "aurax-management-get-client-log-list", "target_dapr_app_id": "aurax-management-service", "target_route": "client-logs", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-aurax-management-create-client-log", "tags": [ "client-logs" ], "summary": "aurax-bff-redirect-aurax-management-create-client-log", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-aurax-management-create-client-log", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "client-logs", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "AuraCommandDto", "payload": "AuraCommandDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "aurax-management-create-client-log", "target_dapr_app_id": "aurax-management-service", "target_route": "client-logs", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/client-logs/{id}": { "delete": { "operationId": "aurax-bff-redirect-aurax-management-delete-client-log", "tags": [ "client-logs" ], "summary": "aurax-bff-redirect-aurax-management-delete-client-log", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-aurax-management-delete-client-log", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "client-logs/{id}", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "forwarded": { "service_code": "aurax-management-delete-client-log", "target_dapr_app_id": "aurax-management-service", "target_route": "client-logs/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_CLNTLG_1", "status": 400, "message": null, "message_available": false, "constant_name": "CLIENT_LOG_ID_NOT_FOUND" } ] } }, "get": { "operationId": "aurax-bff-redirect-aurax-management-get-client-log-by-id", "tags": [ "client-logs" ], "summary": "aurax-bff-redirect-aurax-management-get-client-log-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-aurax-management-get-client-log-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "client-logs/{id}", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "ClientLogDto", "payload": "ClientLogDto", "collection": false, "members": [ { "name": "ClientDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "TransactionDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "UrlPath", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LanguageCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UserCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ClientIp", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ClientDeviceDetail", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ErrorMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FormDefinitionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ErrorStack", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "aurax-management-get-client-log-by-id", "target_dapr_app_id": "aurax-management-service", "target_route": "client-logs/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_CLNTLG_1", "status": 400, "message": null, "message_available": false, "constant_name": "CLIENT_LOG_ID_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-aurax-management-update-client-log", "tags": [ "client-logs" ], "summary": "aurax-bff-redirect-aurax-management-update-client-log", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-aurax-management-update-client-log", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "client-logs/{id}", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/clients": { "get": { "operationId": "aurax-bff-redirect-get-client-list", "tags": [ "clients" ], "summary": "aurax-bff-redirect-get-client-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-client-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "clients", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/clients/permissions": { "post": { "operationId": "aurax-bff-redirect-create-permission-bpm", "tags": [ "clients" ], "summary": "aurax-bff-redirect-create-permission-bpm", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-permission-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "clients/permissions", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/clients/{clientId}/evaluate-policy": { "post": { "operationId": "aurax-bff-redirect-evaluate-client-authorization", "tags": [ "clients" ], "summary": "aurax-bff-redirect-evaluate-client-authorization", "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-evaluate-client-authorization", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "clients/{clientId}/evaluate-policy", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/clients/{clientId}/permissions": { "get": { "operationId": "aurax-bff-redirect-get-permission-list", "tags": [ "clients" ], "summary": "aurax-bff-redirect-get-permission-list", "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-permission-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "clients/{clientId}/permissions", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "post": { "operationId": "aurax-bff-redirect-create-permission", "tags": [ "clients" ], "summary": "aurax-bff-redirect-create-permission", "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-permission", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "clients/{clientId}/permissions", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/clients/{clientId}/permissions/{permissionId}": { "delete": { "operationId": "aurax-bff-redirect-delete-permission", "tags": [ "clients" ], "summary": "aurax-bff-redirect-delete-permission", "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "permissionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-permission", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "clients/{clientId}/permissions/{permissionId}", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "get": { "operationId": "aurax-bff-redirect-get-permission-by-id", "tags": [ "clients" ], "summary": "aurax-bff-redirect-get-permission-by-id", "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "permissionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-permission-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "clients/{clientId}/permissions/{permissionId}", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "put": { "operationId": "aurax-bff-redirect-update-permission", "tags": [ "clients" ], "summary": "aurax-bff-redirect-update-permission", "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "permissionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-permission", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "clients/{clientId}/permissions/{permissionId}", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/clients/{clientId}/policies": { "get": { "operationId": "aurax-bff-redirect-get-policy-list", "tags": [ "clients" ], "summary": "aurax-bff-redirect-get-policy-list", "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-policy-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "clients/{clientId}/policies", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "post": { "operationId": "aurax-bff-redirect-create-policy", "tags": [ "clients" ], "summary": "aurax-bff-redirect-create-policy", "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-policy", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "clients/{clientId}/policies", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/clients/{clientId}/policies/providers": { "get": { "operationId": "aurax-bff-redirect-get-policy-provider-list", "tags": [ "clients" ], "summary": "aurax-bff-redirect-get-policy-provider-list", "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-policy-provider-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "clients/{clientId}/policies/providers", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/clients/{clientId}/policies/{policyId}": { "delete": { "operationId": "aurax-bff-redirect-delete-policy", "tags": [ "clients" ], "summary": "aurax-bff-redirect-delete-policy", "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "policyId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-policy", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "clients/{clientId}/policies/{policyId}", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "get": { "operationId": "aurax-bff-redirect-get-policy-by-id", "tags": [ "clients" ], "summary": "aurax-bff-redirect-get-policy-by-id", "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "policyId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-policy-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "clients/{clientId}/policies/{policyId}", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "put": { "operationId": "aurax-bff-redirect-update-policy", "tags": [ "clients" ], "summary": "aurax-bff-redirect-update-policy", "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "policyId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-policy", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "clients/{clientId}/policies/{policyId}", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/clients/{clientId}/policies/{policyId}/associatedPolicies": { "get": { "operationId": "aurax-bff-redirect-get-associated-policy-list", "tags": [ "clients" ], "summary": "aurax-bff-redirect-get-associated-policy-list", "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "policyId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-associated-policy-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "clients/{clientId}/policies/{policyId}/associatedPolicies", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/clients/{clientId}/policies/{policyId}/dependentPolicies": { "get": { "operationId": "aurax-bff-redirect-get-dependent-policy-list", "tags": [ "clients" ], "summary": "aurax-bff-redirect-get-dependent-policy-list", "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "policyId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-dependent-policy-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "clients/{clientId}/policies/{policyId}/dependentPolicies", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/clients/{clientId}/policies/{policyId}/resources": { "get": { "operationId": "aurax-bff-redirect-get-policy-resource-list", "tags": [ "clients" ], "summary": "aurax-bff-redirect-get-policy-resource-list", "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "policyId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-policy-resource-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "clients/{clientId}/policies/{policyId}/resources", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/clients/{clientId}/policies/{policyId}/scopes": { "get": { "operationId": "aurax-bff-redirect-get-policy-scope-list", "tags": [ "clients" ], "summary": "aurax-bff-redirect-get-policy-scope-list", "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "policyId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-policy-scope-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "clients/{clientId}/policies/{policyId}/scopes", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/clients/{clientId}/resources": { "get": { "operationId": "aurax-bff-redirect-get-resource-list", "tags": [ "clients" ], "summary": "aurax-bff-redirect-get-resource-list", "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-resource-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "clients/{clientId}/resources", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "post": { "operationId": "aurax-bff-redirect-create-resource", "tags": [ "clients" ], "summary": "aurax-bff-redirect-create-resource", "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-resource", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "clients/{clientId}/resources", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/clients/{clientId}/resources/by-name/{resourceName}/authorities": { "get": { "operationId": "aurax-bff-redirect-get-resource-authority-list", "tags": [ "clients" ], "summary": "aurax-bff-redirect-get-resource-authority-list", "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "resourceName", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-resource-authority-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "clients/{clientId}/resources/by-name/{resourceName}/authorities", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "ClientId", "declared_type": null, "nullable": false, "collection": false }, { "name": "ResourceName", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "GetResourceAuthorityListDto", "payload": "GetResourceAuthorityListDto", "collection": false, "members": [ { "name": "Users", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Roles", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Groups", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-resource-authority-list", "target_dapr_app_id": "core-service", "target_route": "clients/{clientId}/resources/by-name/{resourceName}/authorities", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/clients/{clientId}/resources/{resourceId}": { "delete": { "operationId": "aurax-bff-redirect-delete-resource", "tags": [ "clients" ], "summary": "aurax-bff-redirect-delete-resource", "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "resourceId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-resource", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "clients/{clientId}/resources/{resourceId}", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "get": { "operationId": "aurax-bff-redirect-get-resource-by-id", "tags": [ "clients" ], "summary": "aurax-bff-redirect-get-resource-by-id", "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "resourceId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-resource-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "clients/{clientId}/resources/{resourceId}", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "put": { "operationId": "aurax-bff-redirect-update-resource", "tags": [ "clients" ], "summary": "aurax-bff-redirect-update-resource", "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "resourceId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-resource", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "clients/{clientId}/resources/{resourceId}", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/clients/{clientId}/resources/{resourceId}/permissions": { "get": { "operationId": "aurax-bff-redirect-get-resource-permission-list", "tags": [ "clients" ], "summary": "aurax-bff-redirect-get-resource-permission-list", "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "resourceId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-resource-permission-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "clients/{clientId}/resources/{resourceId}/permissions", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/clients/{clientId}/scopes": { "get": { "operationId": "aurax-bff-redirect-get-scope-list", "tags": [ "clients" ], "summary": "aurax-bff-redirect-get-scope-list", "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-scope-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "clients/{clientId}/scopes", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "post": { "operationId": "aurax-bff-redirect-create-scope", "tags": [ "clients" ], "summary": "aurax-bff-redirect-create-scope", "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-scope", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "clients/{clientId}/scopes", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/clients/{clientId}/scopes/{scopeId}": { "delete": { "operationId": "aurax-bff-redirect-delete-scope", "tags": [ "clients" ], "summary": "aurax-bff-redirect-delete-scope", "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "scopeId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-scope", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "clients/{clientId}/scopes/{scopeId}", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "get": { "operationId": "aurax-bff-redirect-get-scope-by-id", "tags": [ "clients" ], "summary": "aurax-bff-redirect-get-scope-by-id", "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "scopeId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-scope-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "clients/{clientId}/scopes/{scopeId}", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "put": { "operationId": "aurax-bff-redirect-update-scope", "tags": [ "clients" ], "summary": "aurax-bff-redirect-update-scope", "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "scopeId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-scope", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "clients/{clientId}/scopes/{scopeId}", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/clients/{clientId}/scopes/{scopeId}/permissions": { "get": { "operationId": "aurax-bff-redirect-get-scope-permission-list", "tags": [ "clients" ], "summary": "aurax-bff-redirect-get-scope-permission-list", "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "scopeId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-scope-permission-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "clients/{clientId}/scopes/{scopeId}/permissions", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/clients/{clientId}/scopes/{scopeId}/resources": { "get": { "operationId": "aurax-bff-redirect-get-scope-resource-list", "tags": [ "clients" ], "summary": "aurax-bff-redirect-get-scope-resource-list", "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "scopeId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-scope-resource-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "clients/{clientId}/scopes/{scopeId}/resources", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/collateral-types": { "get": { "operationId": "aurax-bff-redirect-get-collateral-type-list", "tags": [ "collateral-types" ], "summary": "aurax-bff-redirect-get-collateral-type-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-collateral-type-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "collateral-types", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "CollateralTypeDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MainType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Type", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": "bool?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-collateral-type-list", "target_dapr_app_id": "collateral-service", "target_route": "collateral-types", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-collateral-type-ui-bpmn", "tags": [ "collateral-types" ], "summary": "aurax-bff-redirect-create-collateral-type-ui-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-collateral-type-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "collateral-types", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Code", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "MainType", "declared_type": null, "nullable": true, "collection": false }, { "name": "Type", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/collateral-types/{id}": { "get": { "operationId": "aurax-bff-redirect-get-collateral-type-details-by-id", "tags": [ "collateral-types" ], "summary": "aurax-bff-redirect-get-collateral-type-details-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-collateral-type-details-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "collateral-types/{id}", "x-aura-code-response": { "state": "structure", "declared_type": "CollateralTypeDetailsDto", "payload": "CollateralTypeDetailsDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MainType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Type", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "Fields", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-collateral-type-details-by-id", "target_dapr_app_id": "collateral-service", "target_route": "collateral-types/{id}/details", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_CLLTRL_2", "status": 400, "message": { "ar": "نوع الضمان غير موجود. الرقم المعرف: {0}", "en": "Collateral type cannot be found.: {0}", "tr": "Teminat türü bulunamadı. : {0}" }, "message_available": true, "constant_name": "COLLATERAL_TYPE_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-collateral-type-and-fields-bpmn", "tags": [ "collateral-types" ], "summary": "aurax-bff-redirect-update-collateral-type-and-fields-bpmn", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-collateral-type-and-fields-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "collateral-types/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "MainType", "declared_type": null, "nullable": true, "collection": false }, { "name": "Type", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/collaterals": { "get": { "operationId": "aurax-bff-redirect-get-collateral-list", "tags": [ "collaterals" ], "summary": "aurax-bff-redirect-get-collateral-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-collateral-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "collaterals", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "CollateralDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CollateralTypeId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CollateralNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Amount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UsableRate", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "Date", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "MaturityDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "ExpiryDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "PledgeAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "Fields", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Pledges", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Usages", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-collateral-list", "target_dapr_app_id": "collateral-service", "target_route": "collaterals", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-customer-collateral-ui-bpmn", "tags": [ "collaterals" ], "summary": "aurax-bff-redirect-create-customer-collateral-ui-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-customer-collateral-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "collaterals", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/collaterals/pledges": { "get": { "operationId": "aurax-bff-redirect-get-pledge-list", "tags": [ "collaterals" ], "summary": "aurax-bff-redirect-get-pledge-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-pledge-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "collaterals/pledges", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "PledgeDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CollateralId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "NotaryPledgeNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Amount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "NotaryTransactionNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RemovalDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "StartDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "EndDate", "declared_type": "DateTime?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-pledge-list", "target_dapr_app_id": "collateral-service", "target_route": "collaterals/pledges", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-pledge-ui-bpmn", "tags": [ "collaterals" ], "summary": "aurax-bff-redirect-create-pledge-ui-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-pledge-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "collaterals/pledges", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/collaterals/usages": { "post": { "operationId": "aurax-bff-redirect-create-customer-collateral-usage-ui-bpmn", "tags": [ "collaterals" ], "summary": "aurax-bff-redirect-create-customer-collateral-usage-ui-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-customer-collateral-usage-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "collaterals/usages", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/collaterals/usages/{loanId}": { "get": { "operationId": "aurax-bff-redirect-get-collateral-usage-by-loan-id", "tags": [ "collaterals" ], "summary": "aurax-bff-redirect-get-collateral-usage-by-loan-id", "parameters": [ { "name": "loanId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-collateral-usage-by-loan-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "collaterals/usages/{loanId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "LoanId", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "CollateralUsageDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CollateralId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "UsageType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "LoanId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Amount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "UsageDate", "declared_type": "DateTime?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-collateral-usage-by-loan-id", "target_dapr_app_id": "collateral-service", "target_route": "collaterals/usages/{loanId}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/collaterals/{id}": { "get": { "operationId": "aurax-bff-redirect-get-collateral-by-id", "tags": [ "collaterals" ], "summary": "aurax-bff-redirect-get-collateral-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-collateral-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "collaterals/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "CollateralDto", "payload": "CollateralDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CollateralTypeId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CollateralNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Amount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UsableRate", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "Date", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "MaturityDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "ExpiryDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "PledgeAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "Fields", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Pledges", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Usages", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-collateral-by-id", "target_dapr_app_id": "collateral-service", "target_route": "collaterals/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "put": { "operationId": "aurax-bff-redirect-update-customer-collateral-ui-bpmn", "tags": [ "collaterals" ], "summary": "aurax-bff-redirect-update-customer-collateral-ui-bpmn", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-customer-collateral-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "collaterals/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "CollateralTypeId", "declared_type": null, "nullable": true, "collection": false }, { "name": "CollateralNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": true, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "Amount", "declared_type": null, "nullable": true, "collection": false }, { "name": "CurrencyCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "UsableRate", "declared_type": null, "nullable": true, "collection": false }, { "name": "StartDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "MaturityDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "ExpiryDate", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/collaterals/{id}/pledges": { "get": { "operationId": "aurax-bff-redirect-get-pledge-list-by-collateral-id", "tags": [ "collaterals" ], "summary": "aurax-bff-redirect-get-pledge-list-by-collateral-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-pledge-list-by-collateral-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "collaterals/{id}/pledges", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "PledgeDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CollateralId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "NotaryPledgeNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Amount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "NotaryTransactionNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RemovalDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "StartDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "EndDate", "declared_type": "DateTime?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-pledge-list-by-collateral-id", "target_dapr_app_id": "collateral-service", "target_route": "collaterals/{id}/pledges", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_CLLTRL_13", "status": 400, "message": { "ar": "الضمان غير موجود. المعرف:{0}", "en": "Collateral cannot be found. :{0}", "tr": "Teminat bulunamadı.: {0}" }, "message_available": true, "constant_name": "COLLATERAL_NOT_FOUND" } ] } } }, "/collaterals/{id}/pledges/{pledgeId}": { "get": { "operationId": "aurax-bff-redirect-get-pledge-by-id", "tags": [ "collaterals" ], "summary": "aurax-bff-redirect-get-pledge-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "pledgeId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-pledge-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "collaterals/{id}/pledges/{pledgeId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "PledgeId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "PledgeDto", "payload": "PledgeDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CollateralId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "NotaryPledgeNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Amount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "NotaryTransactionNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RemovalDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "StartDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "EndDate", "declared_type": "DateTime?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-pledge-by-id", "target_dapr_app_id": "collateral-service", "target_route": "collaterals/{id}/pledges/{pledgeId}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_CLLTRL_13", "status": 400, "message": { "ar": "الضمان غير موجود. المعرف:{0}", "en": "Collateral cannot be found. :{0}", "tr": "Teminat bulunamadı.: {0}" }, "message_available": true, "constant_name": "COLLATERAL_NOT_FOUND" }, { "code": "ERR_CLLTRL_19", "status": 400, "message": null, "message_available": false, "constant_name": "PLEDGE_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-pledge-ui-bpmn", "tags": [ "collaterals" ], "summary": "aurax-bff-redirect-update-pledge-ui-bpmn", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "pledgeId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-pledge-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "collaterals/{id}/pledges/{pledgeId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "PledgeId", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": true, "collection": false }, { "name": "NotaryPledgeNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "Amount", "declared_type": null, "nullable": true, "collection": false }, { "name": "NotaryTransactionNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "RemovalDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "StartDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "EndDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "Status", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/collaterals/{id}/usages": { "get": { "operationId": "aurax-bff-redirect-get-collateral-usage-list", "tags": [ "collaterals" ], "summary": "aurax-bff-redirect-get-collateral-usage-list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-collateral-usage-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "collaterals/{id}/usages", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "CollateralUsageDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CollateralId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "UsageType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "LoanId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Amount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "UsageDate", "declared_type": "DateTime?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-collateral-usage-list", "target_dapr_app_id": "collateral-service", "target_route": "collaterals/{id}/usages", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_CLLTRL_13", "status": 400, "message": { "ar": "الضمان غير موجود. المعرف:{0}", "en": "Collateral cannot be found. :{0}", "tr": "Teminat bulunamadı.: {0}" }, "message_available": true, "constant_name": "COLLATERAL_NOT_FOUND" } ] } } }, "/collaterals/{id}/usages/{collateralUsageId}": { "get": { "operationId": "aurax-bff-redirect-get-collateral-usage-by-id", "tags": [ "collaterals" ], "summary": "aurax-bff-redirect-get-collateral-usage-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "collateralUsageId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-collateral-usage-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "collaterals/{id}/usages/{collateralUsageId}", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "CollateralUsageDto", "payload": "CollateralUsageDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CollateralId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "UsageType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "LoanId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Amount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "UsageDate", "declared_type": "DateTime?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-collateral-usage-by-id", "target_dapr_app_id": "collateral-service", "target_route": "collaterals/{id}/usages/{collateralUsageId}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/committees": { "get": { "operationId": "aurax-bff-get-committee-list", "tags": [ "committees" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-get-committee-list", "description": "Request and response fields are declared on the routing target `get-committee-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "committeeName": { "type": "string", "x-aura-field-code": "committeeName" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "committeeId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "maxAuthorizationLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "maxAuthorizationLimitAmount" }, "requiredSignerCount": { "type": "integer", "format": "int32", "x-aura-field-code": "requiredSignerCount" }, "signatories": { "type": "array", "items": { "type": "object", "properties": { "committeeId": { "type": "string", "format": "uuid", "x-aura-field-code": "committeeId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "signatoryId" }, "userId": { "type": "string", "format": "uuid", "x-aura-field-code": "userId" } }, "x-aura-field-code": "signatories" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-get-committee-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "committees", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-committee-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "CommitteeDto", "collection": true, "members": [ { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "CommitteeName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RequiredSignerCount", "declared_type": "int", "nullable": false, "collection": false }, { "name": "MaxAuthorizationLimitAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "Signatories", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." } }, "post": { "operationId": "aurax-bff-create-committee-ui-bpmn", "tags": [ "committees" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-create-committee-ui-bpmn", "description": "Request and response fields are declared on the routing target `create-committee-ui-bpmn`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "committeeName": { "type": "string", "x-aura-field-code": "committeeName" }, "maxAuthorizationLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "maxAuthorizationLimitAmount" }, "requiredSignerCount": { "type": "integer", "format": "int32", "x-aura-field-code": "requiredSignerCount" }, "signatories": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "string", "format": "uuid", "x-aura-field-code": "userId" } }, "required": [ "userId" ], "x-aura-field-code": "signatories" } } }, "required": [ "committeeName", "maxAuthorizationLimitAmount", "requiredSignerCount", "signatories" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 4, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-create-committee-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "committees", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CommitteeName", "declared_type": null, "nullable": false, "collection": false }, { "name": "RequiredSignerCount", "declared_type": null, "nullable": false, "collection": false }, { "name": "MaxAuthorizationLimitAmount", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/committees/{id}": { "delete": { "operationId": "aurax-bff-delete-committee-ui-bpmn", "tags": [ "committees" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-delete-committee-ui-bpmn", "description": "Request and response fields are declared on the routing target `delete-committee-ui-bpmn`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "committeeId" } } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-delete-committee-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "committees/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "get": { "operationId": "aurax-bff-get-committee-by-id", "tags": [ "committees" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-get-committee-by-id", "description": "Request and response fields are declared on the routing target `get-committee-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "committeeId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "committeeName": { "type": "string", "x-aura-field-code": "committeeName" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "committeeId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "maxAuthorizationLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "maxAuthorizationLimitAmount" }, "requiredSignerCount": { "type": "integer", "format": "int32", "x-aura-field-code": "requiredSignerCount" }, "signatories": { "type": "array", "items": { "type": "object", "properties": { "committeeId": { "type": "string", "format": "uuid", "x-aura-field-code": "committeeId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "signatoryId" }, "userId": { "type": "string", "format": "uuid", "x-aura-field-code": "userId" } }, "x-aura-field-code": "signatories" } } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-get-committee-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "committees/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "CommitteeDto", "payload": "CommitteeDto", "collection": false, "members": [ { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "CommitteeName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RequiredSignerCount", "declared_type": "int", "nullable": false, "collection": false }, { "name": "MaxAuthorizationLimitAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "Signatories", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_COMMITTEE_3", "status": 400, "message": { "ar": "لم يتم العثور على اللجنة. المعرف: {0}", "en": "Committee not found. Id: {0}", "tr": "Komite bulunamadı. Id: {0}" }, "message_available": true, "constant_name": "COMMITTEE_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-update-committee-ui-bpmn", "tags": [ "committees" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-update-committee-ui-bpmn", "description": "Request and response fields are declared on the routing target `update-committee-ui-bpmn`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "committeeId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "committeeName": { "type": "string", "x-aura-field-code": "committeeName" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "maxAuthorizationLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "maxAuthorizationLimitAmount" }, "requiredSignerCount": { "type": "integer", "format": "int32", "x-aura-field-code": "requiredSignerCount" }, "signatories": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "_rowStatus" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "signatoryId" }, "userId": { "type": "string", "format": "uuid", "x-aura-field-code": "userId" } }, "x-aura-field-code": "signatories" } } }, "required": [ "committeeName", "isActive", "maxAuthorizationLimitAmount", "requiredSignerCount" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 5, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-update-committee-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "committees/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": null, "nullable": false, "collection": false }, { "name": "CommitteeName", "declared_type": null, "nullable": false, "collection": false }, { "name": "RequiredSignerCount", "declared_type": null, "nullable": false, "collection": false }, { "name": "MaxAuthorizationLimitAmount", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/compensating-transactions/resolve": { "post": { "operationId": "aurax-bff-redirect-resolve-correlation-bpm", "tags": [ "compensating-transactions" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "resolve-correlation-bpm", "description": "Invokes the `aurax-bff-redirect-resolve-correlation-bpm` service definition through `POST /compensating-transactions/resolve`.", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-resolve-correlation-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "compensating-transactions/resolve", "x-aura-capabilities": { "bpm_variables": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Status", "declared_type": null, "nullable": true, "collection": false }, { "name": "CorrelationId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/complete-fasts": { "post": { "operationId": "aurax-bff-service-dynamic-complete-fast-money-transfer-bpm", "tags": [ "complete-fasts" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-complete-fast-money-transfer-bpm", "description": "Request and response fields are declared on the routing target `complete-fast-money-transfer-bpm`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "confirmCode": { "type": "integer", "format": "int32", "x-aura-field-code": "confirmCode" }, "confirmCodeDetail": { "type": "integer", "format": "int32", "x-aura-field-code": "confirmCodeDetail" }, "fromParticipantCode": { "type": "string", "x-aura-field-code": "fromParticipantCode" }, "queryNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "fastQueryNumber" }, "related": { "type": "object", "properties": { "fromParticipantCode": { "type": "string", "x-aura-field-code": "fromParticipantCode" }, "queryNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "fastQueryNumber" }, "transactionDate": { "type": "string", "format": "date", "x-aura-field-code": "transactionDate" } }, "required": [ "fromParticipantCode", "queryNumber", "transactionDate" ], "x-aura-field-code": "related" }, "toParticipantCode": { "type": "string", "x-aura-field-code": "toParticipantCode" }, "transactionDate": { "type": "string", "format": "date", "x-aura-field-code": "transactionDate" } }, "required": [ "confirmCode", "confirmCodeDetail", "fromParticipantCode", "queryNumber", "related", "toParticipantCode", "transactionDate" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 7, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-complete-fast-money-transfer-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "complete-fasts", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/configs": { "get": { "operationId": "aurax-bff-redirect-get-config-list", "tags": [ "configs" ], "summary": "aurax-bff-redirect-get-config-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-config-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "configs", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "ConfigDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FieldValue", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-config-list", "target_dapr_app_id": "core-service", "target_route": "configs", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-config", "tags": [ "configs" ], "summary": "aurax-bff-redirect-create-config", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-config", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "configs", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Code", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "FieldValue", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/configs/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-config", "tags": [ "configs" ], "summary": "aurax-bff-redirect-delete-config", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-config", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "configs/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "get": { "operationId": "aurax-bff-redirect-get-config-by-id", "tags": [ "configs" ], "summary": "aurax-bff-redirect-get-config-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-config-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "configs/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ConfigDto", "payload": "ConfigDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FieldValue", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-config-by-id", "target_dapr_app_id": "core-service", "target_route": "configs/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_CORE_156", "status": 400, "message": { "ar": "معرف التكوين لا يمكن أن يكون فارغًا", "en": "Config cannot be left blank.", "tr": "Yapılandırma boş olamaz" }, "message_available": true, "constant_name": "CONFIG_MUST_BE_NOT_NULL" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-config", "tags": [ "configs" ], "summary": "aurax-bff-redirect-update-config", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-config", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "configs/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "FieldValue", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/consent-items": { "get": { "operationId": "aurax-bff-dynamic-get-consent-item-list", "tags": [ "consent-items" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-consent-item-list", "description": "Request and response fields are declared on the routing target `get-consent-item-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "consentItemCode" }, "consentItemDimensions": { "type": "array", "items": { "type": "object", "properties": { "consentItemId": { "type": "string", "format": "uuid", "x-aura-field-code": "consentItemId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "consentItemDimensionId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "transactionType": { "type": "integer", "format": "int32", "x-aura-field-code": "transactionType" } }, "x-aura-field-code": "consentItemDimensions" } }, "consentServiceMaps": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "consentItemCode" }, "consentItemId": { "type": "string", "format": "uuid", "x-aura-field-code": "consentItemId" }, "description": { "type": "string", "x-aura-field-code": "description" }, "documentItemId": { "type": "string", "format": "uuid", "x-aura-field-code": "documentItemId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "consentServiceMapId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "name": { "type": "string", "x-aura-field-code": "consentItemName" }, "necessity": { "type": "integer", "format": "int32", "x-aura-field-code": "necessity" }, "processDefinitionId": { "type": "string", "format": "uuid", "x-aura-field-code": "processDefinitionId" }, "sequenceNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "sequenceNumber" }, "templateDesignId": { "type": "string", "format": "uuid", "x-aura-field-code": "templateDesignId" } }, "x-aura-field-code": "consentServiceMaps" } }, "description": { "type": "string", "x-aura-field-code": "description" }, "documentItemId": { "type": "string", "format": "uuid", "x-aura-field-code": "documentItemId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "consentItemId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "name": { "type": "string", "x-aura-field-code": "consentItemName" }, "templateDesignId": { "type": "string", "format": "uuid", "x-aura-field-code": "templateDesignId" }, "translations": { "type": "array", "items": { "type": "object", "properties": { "languageCode": { "type": "string", "x-aura-field-code": "languageCode" }, "name": { "type": "string", "x-aura-field-code": "translations_name" } }, "x-aura-field-code": "translations" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-consent-item-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "consent-items", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-consent-item-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "route-claimed-by-two-repositories", "note": "Two services register this method and path, so this portal cannot say which one's request fields these would be. The fields a caller sends are exactly what would differ between them, so nothing is published rather than one of the two." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/consent-items/consent-service-maps": { "get": { "operationId": "aurax-bff-redirect-get-consent-service-map-list", "tags": [ "consent-items" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-consent-service-map-list", "description": "Request and response fields are declared on the routing target `get-consent-service-map-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "consentItemCode" }, "consentItemId": { "type": "string", "format": "uuid", "x-aura-field-code": "consentItemId" }, "description": { "type": "string", "x-aura-field-code": "description" }, "documentItemId": { "type": "string", "format": "uuid", "x-aura-field-code": "documentItemId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "consentServiceMapId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "name": { "type": "string", "x-aura-field-code": "consentItemName" }, "necessity": { "type": "integer", "format": "int32", "x-aura-field-code": "necessity" }, "processDefinitionId": { "type": "string", "format": "uuid", "x-aura-field-code": "processDefinitionId" }, "sequenceNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "sequenceNumber" }, "templateDesignId": { "type": "string", "format": "uuid", "x-aura-field-code": "templateDesignId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-consent-service-map-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "consent-items/consent-service-maps", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-consent-service-map-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "route-claimed-by-two-repositories", "note": "Two services register this method and path, so this portal cannot say which one's request fields these would be. The fields a caller sends are exactly what would differ between them, so nothing is published rather than one of the two." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/control-item-groups": { "get": { "operationId": "aurax-bff-redirect-get-control-item-group-list", "tags": [ "control-item-groups" ], "summary": "aurax-bff-redirect-get-control-item-group-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-control-item-group-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "control-item-groups", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "ControlItemGroupDto", "collection": true, "members": [ { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "ControlItems", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-control-item-group-list", "target_dapr_app_id": "customer-evaluation-service", "target_route": "control-item-groups", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-control-item-group-bpmn", "tags": [ "control-item-groups" ], "summary": "aurax-bff-redirect-create-control-item-group-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-control-item-group-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "control-item-groups", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/control-item-groups/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-control-item-group-bpmn", "tags": [ "control-item-groups" ], "summary": "aurax-bff-redirect-delete-control-item-group-bpmn", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-control-item-group-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "control-item-groups/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "get": { "operationId": "aurax-bff-redirect-get-control-item-group-by-id", "tags": [ "control-item-groups" ], "summary": "aurax-bff-redirect-get-control-item-group-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-control-item-group-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "control-item-groups/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ControlItemGroupDto", "payload": "ControlItemGroupDto", "collection": false, "members": [ { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "ControlItems", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-control-item-group-by-id", "target_dapr_app_id": "customer-evaluation-service", "target_route": "control-item-groups/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_CUSEVL_6", "status": 400, "message": { "ar": "لم يتم العثور على مجموعة عنصر التحكم بالمعرف المقدم: '{0}'.", "en": "Control item group cannot be found with the given: {0}.", "tr": "Kontrol öğesi grubu bulunamadı: {0}." }, "message_available": true, "constant_name": "CONTROL_ITEM_GROUP_IS_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-control-item-group-and-control-item-group-map-bpmn", "tags": [ "control-item-groups" ], "summary": "aurax-bff-redirect-update-control-item-group-and-control-item-group-map-bpmn", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-control-item-group-and-control-item-group-map-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "control-item-groups/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/control-items": { "get": { "operationId": "aurax-bff-redirect-get-control-item-list", "tags": [ "control-items" ], "summary": "aurax-bff-redirect-get-control-item-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-control-item-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "control-items", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "ControlItemDto", "collection": true, "members": [ { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "QueryDefinitionId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-control-item-list", "target_dapr_app_id": "customer-evaluation-service", "target_route": "control-items", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-control-item-bpmn", "tags": [ "control-items" ], "summary": "aurax-bff-redirect-create-control-item-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-control-item-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "control-items", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "QueryDefinitionId", "declared_type": null, "nullable": true, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/control-items/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-control-item-bpmn", "tags": [ "control-items" ], "summary": "aurax-bff-redirect-delete-control-item-bpmn", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-control-item-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "control-items/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "get": { "operationId": "aurax-bff-redirect-get-control-item-by-id", "tags": [ "control-items" ], "summary": "aurax-bff-redirect-get-control-item-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-control-item-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "control-items/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ControlItemDto", "payload": "ControlItemDto", "collection": false, "members": [ { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "QueryDefinitionId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-control-item-by-id", "target_dapr_app_id": "customer-evaluation-service", "target_route": "control-items/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_CUSEVL_2", "status": 400, "message": { "ar": "لم يتم العثور على عنصر التحكم بالمعرف المعطى: '{0}'.", "en": "Control item is cannot be found with the given id: {0}.", "tr": "Denetim öğesi bulunamadı: {0}." }, "message_available": true, "constant_name": "CONTROL_ITEM_IS_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-control-item-bpmn", "tags": [ "control-items" ], "summary": "aurax-bff-redirect-update-control-item-bpmn", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-control-item-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "control-items/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "QueryDefinitionId", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/control-views": { "get": { "operationId": "aurax-bff-redirect-get-control-view-list", "tags": [ "control-views" ], "summary": "aurax-bff-redirect-get-control-view-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-control-view-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "control-views", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "ControlViewDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "ControlItemGroups", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-control-view-list", "target_dapr_app_id": "customer-evaluation-service", "target_route": "control-views", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-control-view-bpmn", "tags": [ "control-views" ], "summary": "aurax-bff-redirect-create-control-view-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-control-view-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "control-views", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/control-views/calculate": { "post": { "operationId": "aurax-bff-redirect-calculate-control-view-bpmn", "tags": [ "control-views" ], "summary": "aurax-bff-redirect-calculate-control-view-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-calculate-control-view-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "control-views/calculate", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "ControlViewId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/control-views/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-control-view-bpmn", "tags": [ "control-views" ], "summary": "aurax-bff-redirect-delete-control-view-bpmn", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-control-view-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "control-views/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "get": { "operationId": "aurax-bff-redirect-get-control-view-by-id", "tags": [ "control-views" ], "summary": "aurax-bff-redirect-get-control-view-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-control-view-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "control-views/{id}", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "ControlViewDto", "payload": "ControlViewDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "ControlItemGroups", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-control-view-by-id", "target_dapr_app_id": "customer-evaluation-service", "target_route": "control-views/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_CUSEVL_11", "status": 400, "message": { "ar": "لم يتم العثور على عرض التحكم بالمعرف المُعطى: '{0}'.", "en": "Control view is cannot be found with the given: {0}.", "tr": "Denetim görünümü bulunamadı: {0}." }, "message_available": true, "constant_name": "CONTROL_VIEW_IS_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-control-view-and-create-delete-control-view-map-bpmn", "tags": [ "control-views" ], "summary": "aurax-bff-redirect-update-control-view-and-create-delete-control-view-map-bpmn", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-control-view-and-create-delete-control-view-map-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "control-views/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/copy-authorization-permission": { "post": { "operationId": "aurax-bff-redirect-copy-authorization-permission", "tags": [ "copy-authorization-permission" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-copy-authorization-permission", "description": "Request and response fields are declared on the routing target `copy-authorization-permission`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "clientId": { "type": "string", "x-aura-field-code": "clientId" }, "policyName": { "type": "string", "x-aura-field-code": "policyName" }, "resourceName": { "type": "string", "x-aura-field-code": "resourceName" }, "resourcePolicyId": { "type": "string", "format": "uuid", "x-aura-field-code": "resourcePolicyId" }, "targetPolicyId": { "type": "string", "format": "uuid", "x-aura-field-code": "targetPolicyId" } }, "required": [ "clientId", "policyName", "resourceName", "resourcePolicyId", "targetPolicyId" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 5, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-copy-authorization-permission", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "copy-authorization-permission", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "ClientId", "declared_type": null, "nullable": false, "collection": false }, { "name": "ResourceName", "declared_type": null, "nullable": false, "collection": false }, { "name": "PolicyName", "declared_type": null, "nullable": false, "collection": false }, { "name": "ResourcePolicyId", "declared_type": null, "nullable": false, "collection": false }, { "name": "TargetPolicyId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "declared_type": "Unit", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "payload": "Unit" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_CORE_170", "status": 400, "message": null, "message_available": false, "constant_name": "RESOURCE_AUTHORITY_NOT_FOUND" } ] } } }, "/corporate-assignment-requests": { "get": { "operationId": "aurax-bff-redirect-get-corporate-assignment-request-list", "tags": [ "corporate-assignment-requests" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-corporate-assignment-request-list", "description": "Request and response fields are declared on the routing target `get-corporate-assignment-request-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a collection.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-corporate-assignment-request-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "corporate-assignment-requests", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-corporate-assignment-request-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "CorporateAssignmentRequestDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerGroupId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ProcessStatus", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CorporateAssignmentId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CorporateAssignmentFields", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CorporateAssignmentRequestDecisions", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } }, "post": { "operationId": "aurax-bff-redirect-create-corporate-assignment-request", "tags": [ "corporate-assignment-requests" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-create-corporate-assignment-request", "description": "Request and response fields are declared on the routing target `create-corporate-assignment-request`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "corporateAssignmentFields": { "type": "string", "x-aura-field-code": "corporateAssignmentFields" }, "corporateAssignmentId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateAssignmentId" }, "customerGroupId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerGroupId" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" } }, "required": [ "corporateAssignmentFields", "customerId" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 4, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-corporate-assignment-request", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "corporate-assignment-requests", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerGroupId", "declared_type": null, "nullable": false, "collection": false }, { "name": "CorporateAssignmentId", "declared_type": null, "nullable": true, "collection": false }, { "name": "CorporateAssignmentFields", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "command-id", "note": "The route returns `AuraCommandDto`, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, `Id`, of type `Guid`. A caller gets a JSON OBJECT with one field, not a bare value. The field is `id` on the wire.", "declared_type": "AuraCommandDto", "envelopes": [ "AuraCommandDto" ], "payload": "Guid", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false, "wire_name": "id", "wire_name_basis": "framework-naming-policy" } ], "naming": "Member names are the service's declaration names.", "synthesized": true }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ALLTMNT_64", "status": 400, "message": { "en": "Corporate assignment request already exists for this customer.", "tr": "Bu müşteri için kurumsal atama talebi zaten mevcut" }, "message_available": true, "constant_name": "CORPORATE_ASSIGNMENT_REQUEST_ALREADY_EXISTS_FOR_CUSTOMER" }, { "code": "ERR_ALLTMNT_67", "status": 400, "message": { "en": "Failed to deserialize the corporate assignment fields.", "tr": "Kurumsal tahsis atama alanlarının deseralizasyonu başarısız oldu." }, "message_available": true, "constant_name": "INVALID_CORPORATE_ASSIGNMENT_FIELDS_JSON" }, { "code": "ERR_ALLTMNT_68", "status": 400, "message": { "ar": "لا يمكن أن يكون مبلغ الحد العام المطلوب أقل من مبلغ حد مجموعة المنتجات", "en": "Requested general limit amount cannot be less than product group limit amount", "tr": "Talep edilen genel limit tutarı, ürün grubu limit tutarından az olamaz" }, "message_available": true, "constant_name": "REQUESTED_GENERAL_LIMIT_CANNOT_BE_LESS_THAN_PRODUCT_GROUP_LIMIT" }, { "code": "ERR_ALLTMNT_69", "status": 400, "message": { "ar": "لا يمكن أن يكون مبلغ الحد المطلوب لمجموعة المنتجات أقل من مبلغ حد المنتج", "en": "Product group requested limit amount cannot be less than product limit amount", "tr": "Ürün grubu talep edilen limit tutarı, ürün limit tutarından az olamaz" }, "message_available": true, "constant_name": "PRODUCT_GROUP_REQUESTED_LIMIT_CANNOT_BE_LESS_THAN_PRODUCT_LIMIT" }, { "code": "ERR_ALLTMNT_73", "status": 400, "message": { "ar": "لا يمكن أن يكون تاريخ صلاحية التخصيص في الماضي", "en": "Allotment validity date cannot be in the past", "tr": "Tahsis geçerlilik tarihi geçmiş bir tarih olamaz" }, "message_available": true, "constant_name": "ALLOTMENT_VALIDITY_DATE_CANNOT_BE_IN_PAST" } ] } } }, "/corporate-assignment-requests/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-corporate-assignment-request", "tags": [ "corporate-assignment-requests" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-delete-corporate-assignment-request", "description": "Request and response fields are declared on the routing target `delete-corporate-assignment-request`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateAssignmentRequestId" } } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-corporate-assignment-request", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "corporate-assignment-requests/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ALLTMNT_65", "status": 400, "message": { "en": "Corporate assignment request not found. Request ID: {0}.", "tr": "Kurumsal atama talebi bulunamadı. Talep ID: {0}." }, "message_available": true, "constant_name": "CORPORATE_ASSIGNMENT_REQUEST_NOT_FOUND" }, { "code": "ERR_ALLTMNT_76", "status": 400, "message": null, "message_available": false, "constant_name": "CORPORATE_ASSIGNMENT_REQUEST_NOT_DELETABLE" } ] } }, "get": { "operationId": "aurax-bff-redirect-get-corporate-assignment-request-by-id", "tags": [ "corporate-assignment-requests" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-corporate-assignment-request-by-id", "description": "Request and response fields are declared on the routing target `get-corporate-assignment-request-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateAssignmentRequestId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-corporate-assignment-request-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "corporate-assignment-requests/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "CorporateAssignmentRequestDto", "payload": "CorporateAssignmentRequestDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerGroupId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ProcessStatus", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CorporateAssignmentId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CorporateAssignmentFields", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CorporateAssignmentRequestDecisions", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ALLTMNT_65", "status": 400, "message": { "en": "Corporate assignment request not found. Request ID: {0}.", "tr": "Kurumsal atama talebi bulunamadı. Talep ID: {0}." }, "message_available": true, "constant_name": "CORPORATE_ASSIGNMENT_REQUEST_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-corporate-assignment-request", "tags": [ "corporate-assignment-requests" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-update-corporate-assignment-request", "description": "Request and response fields are declared on the routing target `update-corporate-assignment-request`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateAssignmentRequestId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "corporateAssignmentFields": { "type": "string", "x-aura-field-code": "corporateAssignmentFields" }, "corporateAssignmentId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateAssignmentId" }, "customerGroupId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerGroupId" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" } }, "required": [ "corporateAssignmentFields" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 4, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-corporate-assignment-request", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "corporate-assignment-requests/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerGroupId", "declared_type": null, "nullable": false, "collection": false }, { "name": "CorporateAssignmentId", "declared_type": null, "nullable": true, "collection": false }, { "name": "CorporateAssignmentFields", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ALLTMNT_65", "status": 400, "message": { "en": "Corporate assignment request not found. Request ID: {0}.", "tr": "Kurumsal atama talebi bulunamadı. Talep ID: {0}." }, "message_available": true, "constant_name": "CORPORATE_ASSIGNMENT_REQUEST_NOT_FOUND" }, { "code": "ERR_ALLTMNT_67", "status": 400, "message": { "en": "Failed to deserialize the corporate assignment fields.", "tr": "Kurumsal tahsis atama alanlarının deseralizasyonu başarısız oldu." }, "message_available": true, "constant_name": "INVALID_CORPORATE_ASSIGNMENT_FIELDS_JSON" }, { "code": "ERR_ALLTMNT_68", "status": 400, "message": { "ar": "لا يمكن أن يكون مبلغ الحد العام المطلوب أقل من مبلغ حد مجموعة المنتجات", "en": "Requested general limit amount cannot be less than product group limit amount", "tr": "Talep edilen genel limit tutarı, ürün grubu limit tutarından az olamaz" }, "message_available": true, "constant_name": "REQUESTED_GENERAL_LIMIT_CANNOT_BE_LESS_THAN_PRODUCT_GROUP_LIMIT" }, { "code": "ERR_ALLTMNT_69", "status": 400, "message": { "ar": "لا يمكن أن يكون مبلغ الحد المطلوب لمجموعة المنتجات أقل من مبلغ حد المنتج", "en": "Product group requested limit amount cannot be less than product limit amount", "tr": "Ürün grubu talep edilen limit tutarı, ürün limit tutarından az olamaz" }, "message_available": true, "constant_name": "PRODUCT_GROUP_REQUESTED_LIMIT_CANNOT_BE_LESS_THAN_PRODUCT_LIMIT" }, { "code": "ERR_ALLTMNT_73", "status": 400, "message": { "ar": "لا يمكن أن يكون تاريخ صلاحية التخصيص في الماضي", "en": "Allotment validity date cannot be in the past", "tr": "Tahsis geçerlilik tarihi geçmiş bir tarih olamaz" }, "message_available": true, "constant_name": "ALLOTMENT_VALIDITY_DATE_CANNOT_BE_IN_PAST" }, { "code": "ERR_ALLTMNT_75", "status": 400, "message": null, "message_available": false, "constant_name": "CORPORATE_ASSIGNMENT_REQUEST_NOT_EDITABLE" } ] } } }, "/corporate-assignments": { "get": { "operationId": "aurax-bff-redirect-get-corporate-assignment-list", "tags": [ "corporate-assignments" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-corporate-assignment-list", "description": "Request and response fields are declared on the routing target `get-corporate-assignment-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "allocationPurpose": { "type": "integer", "format": "int32", "x-aura-field-code": "allocationPurpose" }, "allotmentDate": { "type": "string", "format": "date-time", "x-aura-field-code": "allotmentDate" }, "allotmentNumber": { "type": "string", "x-aura-field-code": "allotmentNumber" }, "allotmentValidityDate": { "type": "string", "format": "date-time", "x-aura-field-code": "allotmentValidityDate" }, "approvedGeneralLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "approvedGeneralLimitAmount" }, "collaterals": { "type": "array", "items": { "type": "object", "properties": { "collateralTypeId": { "type": "string", "format": "uuid", "x-aura-field-code": "collateralTypeId" }, "corporateAssignmentId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateAssignmentId" }, "corporateProductGroupLimitId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductGroupLimitId" }, "corporateProductLimitId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductLimitId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductLimitColleteralId" }, "isMandatory": { "type": "boolean", "x-aura-field-code": "isMandatory" }, "level": { "type": "integer", "format": "int32", "x-aura-field-code": "corporateLimitLevel" }, "usageRate": { "type": "number", "format": "decimal", "x-aura-field-code": "usageRate" } }, "x-aura-field-code": "collaterals" } }, "comments": { "type": "array", "items": { "type": "object", "properties": { "commentary": { "type": "string", "x-aura-field-code": "commentary" }, "corporateAssignmentId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateAssignmentId" }, "corporateProductGroupLimitId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductGroupLimitId" }, "corporateProductLimitId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductLimitId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateCommentId" }, "level": { "type": "integer", "format": "int32", "x-aura-field-code": "corporateLimitLevel" } }, "x-aura-field-code": "comments" } }, "committeeId": { "type": "string", "format": "uuid", "x-aura-field-code": "committeeId" }, "currencyId": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyId" }, "currentGeneralLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "currentGeneralLimitAmount" }, "currentGeneralRiskAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "currentGeneralRiskAmount" }, "customerGroupId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerGroupId" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "decisionNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "decisionNumber" }, "financialAnalysisId": { "type": "string", "format": "uuid", "x-aura-field-code": "financialAnalysisId" }, "guarantorInfos": { "type": "array", "items": { "type": "object", "properties": { "corporateAssignmentId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateAssignmentId" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "guarantorAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "guarantorAmount" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateGuarantorInfoId" }, "relationType": { "type": "integer", "format": "int32", "x-aura-field-code": "relationType" } }, "x-aura-field-code": "guarantorInfos" } }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateAssignmentId" }, "organizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "organizationId" }, "productGroupLimits": { "type": "array", "items": { "type": "object", "properties": { "approvedLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "approvedLimitAmount" }, "collaterals": { "type": "array", "items": { "type": "object", "properties": { "collateralTypeId": { "type": "string", "format": "uuid", "x-aura-field-code": "collateralTypeId" }, "corporateAssignmentId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateAssignmentId" }, "corporateProductGroupLimitId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductGroupLimitId" }, "corporateProductLimitId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductLimitId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductLimitColleteralId" }, "isMandatory": { "type": "boolean", "x-aura-field-code": "isMandatory" }, "level": { "type": "integer", "format": "int32", "x-aura-field-code": "corporateLimitLevel" }, "usageRate": { "type": "number", "format": "decimal", "x-aura-field-code": "usageRate" } }, "x-aura-field-code": "collaterals" } }, "comments": { "type": "array", "items": { "type": "object", "properties": { "commentary": { "type": "string", "x-aura-field-code": "commentary" }, "corporateAssignmentId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateAssignmentId" }, "corporateProductGroupLimitId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductGroupLimitId" }, "corporateProductLimitId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductLimitId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateCommentId" }, "level": { "type": "integer", "format": "int32", "x-aura-field-code": "corporateLimitLevel" } }, "x-aura-field-code": "comments" } }, "corporateAssignmentId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateAssignmentId" }, "currentLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "currentLimitAmount" }, "currentRiskAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "currentRiskAmount" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductGroupLimitId" }, "loanProductGroupId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanProductGroupId" }, "productLimits": { "type": "array", "items": { "type": "object", "properties": { "approvedLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "approvedLimitAmount" }, "collaterals": { "type": "array", "items": { "type": "object", "properties": { "collateralTypeId": { "type": "string", "format": "uuid", "x-aura-field-code": "collateralTypeId" }, "corporateAssignmentId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateAssignmentId" }, "corporateProductGroupLimitId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductGroupLimitId" }, "corporateProductLimitId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductLimitId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductLimitColleteralId" }, "isMandatory": { "type": "boolean", "x-aura-field-code": "isMandatory" }, "level": { "type": "integer", "format": "int32", "x-aura-field-code": "corporateLimitLevel" }, "usageRate": { "type": "number", "format": "decimal", "x-aura-field-code": "usageRate" } }, "x-aura-field-code": "collaterals" } }, "comments": { "type": "array", "items": { "type": "object", "properties": { "commentary": { "type": "string", "x-aura-field-code": "commentary" }, "corporateAssignmentId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateAssignmentId" }, "corporateProductGroupLimitId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductGroupLimitId" }, "corporateProductLimitId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductLimitId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateCommentId" }, "level": { "type": "integer", "format": "int32", "x-aura-field-code": "corporateLimitLevel" } }, "x-aura-field-code": "comments" } }, "corporateProductGroupLimitId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductGroupLimitId" }, "currentLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "currentLimitAmount" }, "currentRiskAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "currentRiskAmount" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductLimitId" }, "loanProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanProductId" }, "requestedLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "requestedLimitAmount" } }, "x-aura-field-code": "productLimits" } }, "requestedLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "requestedLimitAmount" } }, "x-aura-field-code": "productGroupLimits" } }, "rejectionReason": { "type": "integer", "format": "int32", "x-aura-field-code": "rejectionReason" }, "requestedGeneralLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "requestedGeneralLimitAmount" }, "senderUserId": { "type": "string", "format": "uuid", "x-aura-field-code": "senderUserId" }, "signatories": { "type": "array", "items": { "type": "object", "properties": { "committeeSignatoryId": { "type": "string", "format": "uuid", "x-aura-field-code": "committeeSignatoryId" }, "corporateAssignmentId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateAssignmentId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateCommitteeSignatoryId" } }, "x-aura-field-code": "signatories" } }, "specialConditions": { "type": "array", "items": { "type": "object", "properties": { "corporateAssignmentId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateAssignmentId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateSpecialConditionId" }, "specialCondition": { "type": "string", "x-aura-field-code": "specialCondition" } }, "x-aura-field-code": "specialConditions" } }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "status" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-corporate-assignment-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "corporate-assignments", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-corporate-assignment-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "CorporateAssignmentDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "AllocationPurpose", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "RejectionReason", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Status", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "AllotmentNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerGroupId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "OrganizationId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "AllotmentDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "AllotmentValidityDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "CommitteeId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "FinancialAnalysisId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "SenderUserId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "DecisionNumber", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CurrencyId", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CurrentGeneralRiskAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CurrentGeneralLimitAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "RequestedGeneralLimitAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "ApprovedGeneralLimitAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "ProductGroupLimits", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Comments", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Signatories", "declared_type": "List", "nullable": false, "collection": true }, { "name": "GuarantorInfos", "declared_type": "List", "nullable": false, "collection": true }, { "name": "SpecialConditions", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Collaterals", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." } }, "post": { "operationId": "aurax-bff-redirect-create-corporate-assignment-ui-bpmn", "tags": [ "corporate-assignments" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-create-corporate-assignment-ui-bpmn", "description": "Request and response fields are declared on the routing target `create-corporate-assignment-ui-bpmn`; this entry declares none of its own.", "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "allocationPurpose": { "type": "integer", "format": "int32", "x-aura-field-code": "allocationPurpose" }, "allotmentDate": { "type": "string", "format": "date-time", "x-aura-field-code": "allotmentDate" }, "allotmentValidityDate": { "type": "string", "format": "date-time", "x-aura-field-code": "allotmentValidityDate" }, "committeeId": { "type": "string", "format": "uuid", "x-aura-field-code": "committeeId" }, "corporateComments": { "type": "array", "items": { "type": "object", "properties": { "commentary": { "type": "string", "x-aura-field-code": "commentary" } }, "x-aura-field-code": "corporateComments" } }, "corporateCommitteeSignatories": { "type": "array", "items": { "type": "object", "properties": { "committeeSignatoryId": { "type": "string", "format": "uuid", "x-aura-field-code": "committeeSignatoryId" } }, "x-aura-field-code": "corporateCommitteeSignatories" } }, "corporateFirmLimits": { "type": "object", "properties": { "firmApprovedCashLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "firmApprovedCashLimitAmount" }, "firmApprovedGeneralLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "approvedGeneralLimitAmount" }, "firmApprovedNonCashLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "firmApprovedNonCashLimitAmount" }, "firmCurrentCashLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "firmCurrentCashLimitAmount" }, "firmCurrentCashRiskAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "firmCurrentCashRiskAmount" }, "firmCurrentGeneralLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "currentGeneralLimitAmount" }, "firmCurrentGeneralRiskAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "currentGeneralRiskAmount" }, "firmCurrentNonCashLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "firmCurrentNonCashLimitAmount" }, "firmCurrentNonCashRiskAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "firmCurrentNonCashRiskAmount" }, "firmRequestedCashLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "firmRequestedCashLimitAmount" }, "firmRequestedGeneralLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "requestedGeneralLimitAmount" }, "firmRequestedNonCashLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "firmRequestedNonCashLimitAmount" } }, "x-aura-field-code": "corporateFirmLimits" }, "corporateGroupLimits": { "type": "object", "properties": { "groupApprovedCashLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "groupApprovedCashLimitAmount" }, "groupApprovedGeneralLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "groupApprovedGeneralLimitAmount" }, "groupApprovedNonCashLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "groupApprovedNonCashLimitAmount" }, "groupCurrentCashLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "groupCurrentCashLimitAmount" }, "groupCurrentCashRiskAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "groupCurrentCashRiskAmount" }, "groupCurrentGeneralLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "groupCurrentGeneralLimitAmount" }, "groupCurrentGeneralRiskAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "groupCurrentGeneralRiskAmount" }, "groupCurrentNonCashLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "groupCurrentNonCashLimitAmount" }, "groupCurrentNonCashRiskAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "groupCurrentNonCashRiskAmount" }, "groupRequestedCashLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "groupRequestedCashLimitAmount" }, "groupRequestedGeneralLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "groupRequestedGeneralLimitAmount" }, "groupRequestedNonCashLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "groupRequestedNonCashLimitAmount" } }, "x-aura-field-code": "corporateGroupLimits" }, "corporateGuarantorInfos": { "type": "array", "items": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "guarantorAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "guarantorAmount" }, "relationType": { "type": "integer", "format": "int32", "x-aura-field-code": "relationType" } }, "x-aura-field-code": "corporateGuarantorInfos" } }, "corporateProductLimits": { "type": "array", "items": { "type": "object", "properties": { "approvedLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "approvedLimitAmount" }, "corporateProductLimitCollaterals": { "type": "array", "items": { "type": "object", "properties": { "collateralId": { "type": "string", "format": "uuid", "x-aura-field-code": "collateralId" }, "collateralRangeMaxAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "collateralRangeMaxAmount" }, "collateralRangeMinAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "collateralRangeMinAmount" }, "limitId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductLimitId" }, "usageRate": { "type": "number", "format": "decimal", "x-aura-field-code": "usageRate" } }, "x-aura-field-code": "corporateProductLimitCollaterals" } }, "currentLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "currentLimitAmount" }, "loanProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanProductId" }, "requestedLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "requestedLimitAmount" } }, "required": [ "corporateProductLimitCollaterals" ], "x-aura-field-code": "corporateProductLimits" } }, "corporateSpecialConditions": { "type": "array", "items": { "type": "object", "properties": { "specialCondition": { "type": "string", "x-aura-field-code": "specialCondition" } }, "x-aura-field-code": "corporateSpecialConditions" } }, "currencyId": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyId" }, "customerGroupId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerGroupId" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "financialAnalysisId": { "type": "string", "format": "uuid", "x-aura-field-code": "financialAnalysisId" }, "organizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "organizationId" }, "senderUserId": { "type": "string", "format": "uuid", "x-aura-field-code": "senderUserId" } }, "required": [ "allocationPurpose", "committeeId", "corporateCommitteeSignatories", "corporateFirmLimits", "corporateGroupLimits", "corporateProductLimits", "currencyId", "customerGroupId", "customerId" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 17, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-corporate-assignment-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "corporate-assignments", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/corporate-assignments/{id}": { "get": { "operationId": "aurax-bff-redirect-get-corporate-assignment-by-id", "tags": [ "corporate-assignments" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-corporate-assignment-by-id", "x-aura-incomplete-contract": { "note": "Presence of this extension means the request and response schemas on this operation are known to be incomplete. Absence means no declared field was dropped for this reason — it is not a claim that the catalog is otherwise complete." }, "description": "Request and response fields are declared on the routing target `get-corporate-assignment-by-id`; this entry declares none of its own.\n\nINCOMPLETE CONTRACT. The catalog declares 4 response field(s) that this document could NOT place and does not show: the catalog parents this field to a row belonging to a DIFFERENT service, so it is a child of a node that is not part of this contract. So the properties and any `required` array below are a SUBSET of what the catalog declares, not the whole of it. They are dropped rather than re-attached because placing them would mean guessing which node they belong under, and this document does not guess. See `x-aura-incomplete-contract` for the field names.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateAssignmentId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "allocationPurpose": { "type": "integer", "format": "int32", "x-aura-field-code": "allocationPurpose" }, "allotmentDate": { "type": "string", "format": "date-time", "x-aura-field-code": "allotmentDate" }, "allotmentNumber": { "type": "string", "x-aura-field-code": "allotmentNumber" }, "allotmentValidityDate": { "type": "string", "format": "date-time", "x-aura-field-code": "allotmentValidityDate" }, "approvedGeneralLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "approvedGeneralLimitAmount" }, "collaterals": { "type": "array", "items": { "type": "object", "properties": { "collateralTypeId": { "type": "string", "format": "uuid", "x-aura-field-code": "collateralTypeId" }, "conditionGroupNo": { "type": "integer", "format": "int32", "x-aura-field-code": "conditionGroupNo" }, "corporateAssignmentId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateAssignmentId" }, "corporateProductGroupLimitId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductGroupLimitId" }, "corporateProductLimitId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductLimitId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductLimitColleteralId" }, "level": { "type": "integer", "format": "int32", "x-aura-field-code": "corporateLimitLevel" }, "usageRate": { "type": "number", "format": "decimal", "x-aura-field-code": "usageRate" } }, "x-aura-field-code": "collaterals" } }, "comments": { "type": "array", "items": { "type": "object", "properties": { "commentary": { "type": "string", "x-aura-field-code": "commentary" }, "corporateAssignmentId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateAssignmentId" }, "corporateProductGroupLimitId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductGroupLimitId" }, "corporateProductLimitId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductLimitId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateCommentId" }, "level": { "type": "integer", "format": "int32", "x-aura-field-code": "corporateLimitLevel" } }, "x-aura-field-code": "comments" } }, "committeeId": { "type": "string", "format": "uuid", "x-aura-field-code": "committeeId" }, "currencyId": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyId" }, "currentGeneralLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "currentGeneralLimitAmount" }, "currentGeneralRiskAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "currentGeneralRiskAmount" }, "customerGroupId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerGroupId" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "decisionNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "decisionNumber" }, "financialAnalysisId": { "type": "string", "format": "uuid", "x-aura-field-code": "financialAnalysisId" }, "guarantorInfos": { "type": "array", "items": { "type": "object", "properties": { "corporateAssignmentId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateAssignmentId" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "guarantorAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "guarantorAmount" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateGuarantorInfoId" }, "relationType": { "type": "integer", "format": "int32", "x-aura-field-code": "relationType" } }, "x-aura-field-code": "guarantorInfos" } }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateAssignmentId" }, "organizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "organizationId" }, "productGroupLimits": { "type": "array", "items": { "type": "object", "properties": { "approvedLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "approvedLimitAmount" }, "collaterals": { "type": "array", "items": { "type": "object", "properties": { "collateralTypeId": { "type": "string", "format": "uuid", "x-aura-field-code": "collateralTypeId" }, "conditionGroupNo": { "type": "integer", "format": "int32", "x-aura-field-code": "conditionGroupNo" }, "corporateAssignmentId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateAssignmentId" }, "corporateProductGroupLimitId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductGroupLimitId" }, "corporateProductLimitId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductLimitId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductLimitColleteralId" }, "level": { "type": "integer", "format": "int32", "x-aura-field-code": "corporateLimitLevel" }, "usageRate": { "type": "number", "format": "decimal", "x-aura-field-code": "usageRate" } }, "x-aura-field-code": "collaterals" } }, "commentary": { "type": "string", "x-aura-field-code": "commentary" }, "comments": { "type": "array", "items": { "type": "object", "properties": { "commentary": { "type": "string", "x-aura-field-code": "commentary" }, "corporateAssignmentId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateAssignmentId" }, "corporateProductGroupLimitId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductGroupLimitId" }, "corporateProductLimitId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductLimitId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateCommentId" }, "level": { "type": "integer", "format": "int32", "x-aura-field-code": "corporateLimitLevel" } }, "x-aura-field-code": "comments" } }, "corporateAssignmentId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateAssignmentId" }, "currentLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "currentLimitAmount" }, "currentRiskAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "currentRiskAmount" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductGroupLimitId" }, "loanProductGroupId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanProductGroupId" }, "productLimits": { "type": "array", "items": { "type": "object", "properties": { "approvedLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "approvedLimitAmount" }, "collaterals": { "type": "array", "items": { "type": "object", "properties": { "collateralTypeId": { "type": "string", "format": "uuid", "x-aura-field-code": "collateralTypeId" }, "conditionGroupNo": { "type": "integer", "format": "int32", "x-aura-field-code": "conditionGroupNo" }, "corporateAssignmentId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateAssignmentId" }, "corporateProductGroupLimitId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductGroupLimitId" }, "corporateProductLimitId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductLimitId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductLimitColleteralId" }, "level": { "type": "integer", "format": "int32", "x-aura-field-code": "corporateLimitLevel" }, "usageRate": { "type": "number", "format": "decimal", "x-aura-field-code": "usageRate" } }, "x-aura-field-code": "collaterals" } }, "comments": { "type": "array", "items": { "type": "object", "properties": { "commentary": { "type": "string", "x-aura-field-code": "commentary" }, "corporateAssignmentId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateAssignmentId" }, "corporateProductGroupLimitId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductGroupLimitId" }, "corporateProductLimitId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductLimitId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateCommentId" }, "level": { "type": "integer", "format": "int32", "x-aura-field-code": "corporateLimitLevel" } }, "x-aura-field-code": "comments" } }, "corporateProductGroupLimitId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductGroupLimitId" }, "currentLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "currentLimitAmount" }, "currentRiskAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "currentRiskAmount" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductLimitId" }, "loanProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanProductId" }, "requestedLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "requestedLimitAmount" }, "specialConditions": { "type": "array", "items": { "type": "object", "properties": { "corporateAssignmentId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateAssignmentId" }, "corporateProductGroupLimitId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductGroupLimitId" }, "corporateProductLimitId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductLimitId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateSpecialConditionId" }, "level": { "type": "integer", "format": "int32", "x-aura-field-code": "corporateLimitLevel" }, "specialCondition": { "type": "string", "x-aura-field-code": "specialCondition" } }, "x-aura-field-code": "specialConditions" } } }, "x-aura-field-code": "productLimits" } }, "requestedLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "requestedLimitAmount" }, "specialConditions": { "type": "array", "items": { "type": "object", "properties": { "corporateAssignmentId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateAssignmentId" }, "corporateProductGroupLimitId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductGroupLimitId" }, "corporateProductLimitId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductLimitId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateSpecialConditionId" }, "level": { "type": "integer", "format": "int32", "x-aura-field-code": "corporateLimitLevel" }, "specialCondition": { "type": "string", "x-aura-field-code": "specialCondition" } }, "x-aura-field-code": "specialConditions" } } }, "x-aura-field-code": "productGroupLimits" } }, "rejectionReason": { "type": "integer", "format": "int32", "x-aura-field-code": "rejectionReason" }, "requestedGeneralLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "requestedGeneralLimitAmount" }, "senderUserId": { "type": "string", "format": "uuid", "x-aura-field-code": "senderUserId" }, "signatories": { "type": "array", "items": { "type": "object", "properties": { "committeeSignatoryId": { "type": "string", "format": "uuid", "x-aura-field-code": "committeeSignatoryId" }, "corporateAssignmentId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateAssignmentId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateCommitteeSignatoryId" } }, "x-aura-field-code": "signatories" } }, "specialConditions": { "type": "array", "items": { "type": "object", "properties": { "corporateAssignmentId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateAssignmentId" }, "corporateProductGroupLimitId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductGroupLimitId" }, "corporateProductLimitId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductLimitId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateSpecialConditionId" }, "level": { "type": "integer", "format": "int32", "x-aura-field-code": "corporateLimitLevel" }, "specialCondition": { "type": "string", "x-aura-field-code": "specialCondition" } }, "x-aura-field-code": "specialConditions" } }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "status" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-corporate-assignment-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "corporate-assignments/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "CorporateAssignmentDto", "payload": "CorporateAssignmentDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "AllocationPurpose", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "RejectionReason", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Status", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "AllotmentNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerGroupId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "OrganizationId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "AllotmentDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "AllotmentValidityDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "CommitteeId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "FinancialAnalysisId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "SenderUserId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "DecisionNumber", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CurrencyId", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CurrentGeneralRiskAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CurrentGeneralLimitAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "RequestedGeneralLimitAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "ApprovedGeneralLimitAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "ProductGroupLimits", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Comments", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Signatories", "declared_type": "List", "nullable": false, "collection": true }, { "name": "GuarantorInfos", "declared_type": "List", "nullable": false, "collection": true }, { "name": "SpecialConditions", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Collaterals", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ALLTMNT_42", "status": 400, "message": { "ar": "لم يتم العثور على تخصيص التعيين المؤسسي، المعرف: {0}", "en": "Corporate allotment assignment not found, ID: {0}", "tr": "Kurumsal tahsisat görevi bulunamadı, ID: {0}" }, "message_available": true, "constant_name": "CORPORATE_ALLOTMENT_ASSIGNMENT_NOT_FOUND" } ] } }, "post": { "operationId": "aurax-bff-redirect-update-corporate-assignment-ui-bpmn", "tags": [ "corporate-assignments" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-update-corporate-assignment-ui-bpmn", "description": "Request and response fields are declared on the routing target `update-corporate-assignment-ui-bpmn`; this entry declares none of its own.", "deprecated": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in this route template but not among the Route-bound fields of the routing target `update-corporate-assignment-ui-bpmn`, whose own path is decoupled from this one.", "x-aura-source": "route-template-only-after-collapse" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "allocationPurpose": { "type": "integer", "format": "int32", "x-aura-field-code": "allocationPurpose" }, "allotmentDate": { "type": "string", "format": "date-time", "x-aura-field-code": "allotmentDate" }, "allotmentValidityDate": { "type": "string", "format": "date-time", "x-aura-field-code": "allotmentValidityDate" }, "committeeId": { "type": "string", "format": "uuid", "x-aura-field-code": "committeeId" }, "corporateComments": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "_rowStatus" }, "commentary": { "type": "string", "x-aura-field-code": "commentary" } }, "x-aura-field-code": "corporateComments" } }, "corporateCommitteeSignatories": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "_rowStatus" }, "committeeSignatoryId": { "type": "string", "format": "uuid", "x-aura-field-code": "committeeSignatoryId" } }, "x-aura-field-code": "corporateCommitteeSignatories" } }, "corporateFirmLimits": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "_rowStatus" }, "firmApprovedCashLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "firmApprovedCashLimitAmount" }, "firmApprovedGeneralLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "approvedGeneralLimitAmount" }, "firmApprovedNonCashLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "firmApprovedNonCashLimitAmount" }, "firmCurrentCashLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "firmCurrentCashLimitAmount" }, "firmCurrentCashRiskAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "firmCurrentCashRiskAmount" }, "firmCurrentGeneralLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "currentGeneralLimitAmount" }, "firmCurrentGeneralRiskAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "currentGeneralRiskAmount" }, "firmCurrentNonCashLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "firmCurrentNonCashLimitAmount" }, "firmCurrentNonCashRiskAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "firmCurrentNonCashRiskAmount" }, "firmRequestedCashLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "firmRequestedCashLimitAmount" }, "firmRequestedGeneralLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "requestedGeneralLimitAmount" }, "firmRequestedNonCashLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "firmRequestedNonCashLimitAmount" } }, "x-aura-field-code": "corporateFirmLimits" }, "corporateGroupLimits": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "_rowStatus" }, "groupApprovedCashLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "groupApprovedCashLimitAmount" }, "groupApprovedGeneralLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "groupApprovedGeneralLimitAmount" }, "groupApprovedNonCashLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "groupApprovedNonCashLimitAmount" }, "groupCurrentCashLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "groupCurrentCashLimitAmount" }, "groupCurrentCashRiskAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "groupCurrentCashRiskAmount" }, "groupCurrentGeneralLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "groupCurrentGeneralLimitAmount" }, "groupCurrentGeneralRiskAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "groupCurrentGeneralRiskAmount" }, "groupCurrentNonCashLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "groupCurrentNonCashLimitAmount" }, "groupCurrentNonCashRiskAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "groupCurrentNonCashRiskAmount" }, "groupRequestedCashLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "groupRequestedCashLimitAmount" }, "groupRequestedGeneralLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "groupRequestedGeneralLimitAmount" }, "groupRequestedNonCashLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "groupRequestedNonCashLimitAmount" } }, "x-aura-field-code": "corporateGroupLimits" }, "corporateGuarantorInfos": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "_rowStatus" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "guarantorAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "guarantorAmount" }, "relationType": { "type": "integer", "format": "int32", "x-aura-field-code": "relationType" } }, "x-aura-field-code": "corporateGuarantorInfos" } }, "corporateProductLimits": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "_rowStatus" }, "approvedLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "approvedLimitAmount" }, "corporateProductLimitCollaterals": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "_rowStatus" }, "collateralId": { "type": "string", "format": "uuid", "x-aura-field-code": "collateralId" }, "collateralRangeMaxAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "collateralRangeMaxAmount" }, "collateralRangeMinAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "collateralRangeMinAmount" }, "limitId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductLimitId" }, "usageRate": { "type": "number", "format": "decimal", "x-aura-field-code": "usageRate" } }, "x-aura-field-code": "corporateProductLimitCollaterals" } }, "currentLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "currentLimitAmount" }, "loanProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanProductId" }, "requestedLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "requestedLimitAmount" } }, "required": [ "corporateProductLimitCollaterals" ], "x-aura-field-code": "corporateProductLimits" } }, "corporateSpecialConditions": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "_rowStatus" }, "specialCondition": { "type": "string", "x-aura-field-code": "specialCondition" } }, "x-aura-field-code": "corporateSpecialConditions" } }, "currencyId": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyId" }, "customerGroupId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerGroupId" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "financialAnalysisId": { "type": "string", "format": "uuid", "x-aura-field-code": "financialAnalysisId" }, "organizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "organizationId" }, "senderUserId": { "type": "string", "format": "uuid", "x-aura-field-code": "senderUserId" } }, "required": [ "allocationPurpose", "committeeId", "corporateCommitteeSignatories", "corporateFirmLimits", "corporateGroupLimits", "corporateProductLimits", "currencyId", "customerGroupId", "customerId" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 17, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-corporate-assignment-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "corporate-assignments/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/corporate-assignments/{id}/product-group-limit": { "get": { "operationId": "aurax-bff-get-corporate-product-group-limit-list", "tags": [ "corporate-assignments" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-get-corporate-product-group-limit-list", "description": "Request and response fields are declared on the routing target `get-corporate-product-group-limit-list`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateAssignmentId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "approvedLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "approvedLimitAmount" }, "corporateAssignmentId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateAssignmentId" }, "currentLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "currentLimitAmount" }, "currentRiskAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "currentRiskAmount" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductGroupLimitId" }, "loanProductGroupId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanProductGroupId" }, "productLimits": { "type": "array", "items": { "type": "object", "properties": { "approvedLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "approvedLimitAmount" }, "collaterals": { "type": "array", "items": { "type": "object", "properties": { "collateralTypeId": { "type": "string", "format": "uuid", "x-aura-field-code": "collateralTypeId" }, "corporateProductLimitId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductLimitId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductLimitColleteralId" }, "usageRate": { "type": "number", "format": "decimal", "x-aura-field-code": "usageRate" } }, "x-aura-field-code": "collaterals" } }, "corporateProductGroupLimitId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductGroupLimitId" }, "currentLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "currentLimitAmount" }, "currentRiskAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "currentRiskAmount" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductLimitId" }, "loanProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanProductId" }, "requestedLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "requestedLimitAmount" } }, "x-aura-field-code": "productLimits" } }, "requestedLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "requestedLimitAmount" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-get-corporate-product-group-limit-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "corporate-assignments/{id}/product-group-limit", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-corporate-product-group-limit-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "CorporateProductGroupLimitDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CorporateAssignmentId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CurrentRiskAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CurrentLimitAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "RequestedLimitAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "ApprovedLimitAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "LoanProductGroupId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ProductLimits", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Collaterals", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Comments", "declared_type": "List", "nullable": false, "collection": true }, { "name": "SpecialConditions", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ALLTMNT_42", "status": 400, "message": { "ar": "لم يتم العثور على تخصيص التعيين المؤسسي، المعرف: {0}", "en": "Corporate allotment assignment not found, ID: {0}", "tr": "Kurumsal tahsisat görevi bulunamadı, ID: {0}" }, "message_available": true, "constant_name": "CORPORATE_ALLOTMENT_ASSIGNMENT_NOT_FOUND" } ] } } }, "/corporate-assignments/{id}/product-group-limit/{groupLimitId}": { "get": { "operationId": "aurax-bff-get-corporate-product-group-limit-by-id", "tags": [ "corporate-assignments" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-get-corporate-product-group-limit-by-id", "description": "Request and response fields are declared on the routing target `get-corporate-product-group-limit-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateAssignmentId" } }, { "name": "groupLimitId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "groupLimitId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 2, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "approvedLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "approvedLimitAmount" }, "corporateAssignmentId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateAssignmentId" }, "currentLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "currentLimitAmount" }, "currentRiskAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "currentRiskAmount" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductGroupLimitId" }, "loanProductGroupId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanProductGroupId" }, "productLimits": { "type": "array", "items": { "type": "object", "properties": { "approvedLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "approvedLimitAmount" }, "collaterals": { "type": "array", "items": { "type": "object", "properties": { "collateralTypeId": { "type": "string", "format": "uuid", "x-aura-field-code": "collateralTypeId" }, "corporateProductLimitId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductLimitId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductLimitColleteralId" }, "usageRate": { "type": "number", "format": "decimal", "x-aura-field-code": "usageRate" } }, "x-aura-field-code": "collaterals" } }, "corporateProductGroupLimitId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductGroupLimitId" }, "currentLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "currentLimitAmount" }, "currentRiskAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "currentRiskAmount" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateProductLimitId" }, "loanProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanProductId" }, "requestedLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "requestedLimitAmount" } }, "x-aura-field-code": "productLimits" } }, "requestedLimitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "requestedLimitAmount" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-get-corporate-product-group-limit-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "corporate-assignments/{id}/product-group-limit/{groupLimitId}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "GroupLimitId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "CorporateProductGroupLimitDto", "payload": "CorporateProductGroupLimitDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CorporateAssignmentId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CurrentRiskAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CurrentLimitAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "RequestedLimitAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "ApprovedLimitAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "LoanProductGroupId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ProductLimits", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Collaterals", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Comments", "declared_type": "List", "nullable": false, "collection": true }, { "name": "SpecialConditions", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ALLTMNT_42", "status": 400, "message": { "ar": "لم يتم العثور على تخصيص التعيين المؤسسي، المعرف: {0}", "en": "Corporate allotment assignment not found, ID: {0}", "tr": "Kurumsal tahsisat görevi bulunamadı, ID: {0}" }, "message_available": true, "constant_name": "CORPORATE_ALLOTMENT_ASSIGNMENT_NOT_FOUND" }, { "code": "ERR_ALLTMNT_61", "status": 400, "message": { "en": "Corporate product group limit not found for group ID: {0}.", "tr": "Kurumsal ürün grubu limiti bulunamadı. Grup ID: {0}." }, "message_available": true, "constant_name": "CORPORATE_PRODUCT_GROUP_LIMIT_NOT_FOUND" } ] } } }, "/corporate-customers": { "post": { "operationId": "aurax-bff-redirect-create-corporate-customer-ui-bpm", "tags": [ "corporate-customers" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-create-corporate-customer-ui-bpm", "description": "Request and response fields are declared on the routing target `create-corporate-customer-ui-bpm`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "activityLicenseNumber": { "type": "string", "x-aura-field-code": "activityLicenseNumber" }, "addresses": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "addressFields": { "type": "array", "items": { "type": "object", "properties": { "fieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "addressTypeFieldId" }, "fieldValue": { "type": "string", "x-aura-field-code": "addressTypeFieldValue" } }, "x-aura-field-code": "addressFields" } }, "addressName": { "type": "string", "x-aura-field-code": "addressName" }, "addressType": { "type": "integer", "format": "int32", "x-aura-field-code": "addressType" }, "addressTypeId": { "type": "string", "format": "uuid", "x-aura-field-code": "addressTypeId" }, "building": { "type": "integer", "format": "int32", "x-aura-field-code": "country" }, "country": { "type": "integer", "format": "int32", "x-aura-field-code": "country" }, "district": { "type": "integer", "format": "int32", "x-aura-field-code": "country" }, "division": { "type": "integer", "format": "int32", "x-aura-field-code": "country" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "addressId" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "neighbourhood": { "type": "integer", "format": "int32", "x-aura-field-code": "country" }, "rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "section": { "type": "integer", "format": "int32", "x-aura-field-code": "country" }, "street": { "type": "integer", "format": "int32", "x-aura-field-code": "country" } }, "required": [ "_rowStatus", "addressFields", "addressType", "addressTypeId", "isContact", "isDefault" ], "x-aura-field-code": "addresses" } }, "authorities": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "_rowStatus" }, "authorityType": { "type": "integer", "format": "int32", "x-aura-field-code": "authorityType" }, "description": { "type": "string", "x-aura-field-code": "description" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "startDate": { "type": "string", "format": "date-time", "x-aura-field-code": "startDate" }, "toCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "toCustomerId" } }, "x-aura-field-code": "authorities" } }, "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "citizenidType": { "type": "integer", "format": "int32", "x-aura-field-code": "citizenidType" }, "createdOrganizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "createdOrganizationId" }, "customerSubType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerSubType" }, "customerType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerType" }, "emails": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "email": { "type": "string", "x-aura-field-code": "email" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "emailId" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" } }, "required": [ "_rowStatus", "email", "isContact", "isDefault" ], "x-aura-field-code": "emails" } }, "establishCountryDivisionId": { "type": "integer", "format": "int32", "x-aura-field-code": "establishCountryDivisionId" }, "establishCountryId": { "type": "integer", "format": "int32", "x-aura-field-code": "establishCountryId" }, "establishDate": { "type": "string", "format": "date", "x-aura-field-code": "establishDate" }, "freeZone": { "type": "integer", "format": "int32", "x-aura-field-code": "freeZone" }, "fullName": { "type": "string", "x-aura-field-code": "fullName" }, "isFreeZoneCustomer": { "type": "boolean", "x-aura-field-code": "isFreeZoneCustomer" }, "isSeller": { "type": "boolean", "x-aura-field-code": "isSeller" }, "legalOrganizationType": { "type": "integer", "format": "int32", "x-aura-field-code": "legalOrganizationType" }, "licenseEndDate": { "type": "string", "format": "date", "x-aura-field-code": "licenseEndDate" }, "mainOrganizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "mainOrganizationId" }, "naceId": { "type": "string", "format": "uuid", "x-aura-field-code": "naceId" }, "onboardedOrganizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "onboardedOrganizationId" }, "organizationType": { "type": "integer", "format": "int32", "x-aura-field-code": "organizationType" }, "phones": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "phoneId" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "phoneNumber": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true }, "phoneType": { "type": "integer", "format": "int32", "x-aura-field-code": "phoneType" } }, "required": [ "isContact", "isDefault", "phoneNumber", "phoneType" ], "x-aura-field-code": "phones" } }, "registryOfficeCountryDivisionId": { "type": "integer", "format": "int32", "x-aura-field-code": "registryOfficeCountryDivisionId" }, "registryOfficeCountryId": { "type": "integer", "format": "int32", "x-aura-field-code": "registryOfficeCountryId" }, "relations": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "_rowStatus" }, "relationType": { "type": "integer", "format": "int32", "x-aura-field-code": "relationType" }, "shareHolders": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "_rowStatus" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "shareRate": { "type": "number", "format": "decimal", "x-aura-field-code": "shareRate" }, "startDate": { "type": "string", "format": "date-time", "x-aura-field-code": "startDate" } }, "x-aura-field-code": "shareHolders" } }, "toCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "toCustomerId" } }, "x-aura-field-code": "relations" } }, "sectorNaceId": { "type": "string", "format": "uuid", "x-aura-field-code": "sectorNaceId" }, "shortName": { "type": "string", "x-aura-field-code": "shortName" }, "subOrganizationType": { "type": "integer", "format": "int32", "x-aura-field-code": "subOrganizationType" }, "taxOfficeId": { "type": "string", "format": "uuid", "x-aura-field-code": "taxOfficeId" }, "title": { "type": "string", "x-aura-field-code": "title" }, "tradeRegisterNumber": { "type": "string", "x-aura-field-code": "tradeRegisterNumber" } }, "required": [ "citizenid", "citizenidType", "createdOrganizationId", "customerSubType", "customerType", "fullName", "mainOrganizationId", "onboardedOrganizationId" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 32, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "corporateCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateCustomerId" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "customerNumber": { "type": "string", "x-aura-field-code": "customerNumber" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "corporateCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateCustomerId" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "customerNumber": { "type": "string", "x-aura-field-code": "customerNumber" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "corporateCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateCustomerId" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "customerNumber": { "type": "string", "x-aura-field-code": "customerNumber" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-corporate-customer-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "corporate-customers", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/corporate-customers/{id}": { "get": { "operationId": "aurax-bff-get-corporate-customer-by-id", "tags": [ "corporate-customers" ], "summary": "aurax-bff-get-corporate-customer-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-get-corporate-customer-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "corporate-customers/{id}", "x-aura-request-contract": { "state": "no-members" }, "x-aura-code-response": { "state": "structure", "declared_type": "CustomerDetailDto", "payload": "CustomerDetailDto", "collection": false, "members": [ { "name": "CorporateCustomer", "declared_type": "CorporateCustomerDto", "nullable": false, "collection": false }, { "name": "UnlimitedCompanyCustomer", "declared_type": "UnlimitedCompanyCustomerDto", "nullable": false, "collection": false }, { "name": "Addresses", "declared_type": "List", "nullable": false, "collection": true }, { "name": "AddressesUI", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Emails", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Identities", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Nationalities", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Occupations", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Phones", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Residentials", "declared_type": "List", "nullable": false, "collection": true }, { "name": "ConsentItemIds", "declared_type": "List", "nullable": false, "collection": true }, { "name": "CustomerChecks", "declared_type": "List", "nullable": false, "collection": true }, { "name": "CustomerAuthorities", "declared_type": "List", "nullable": false, "collection": true }, { "name": "CustomerRelationships", "declared_type": "List", "nullable": false, "collection": true }, { "name": "CustomerTaxpayers", "declared_type": "List", "nullable": false, "collection": true }, { "name": "CustomerAttributes", "declared_type": "List", "nullable": false, "collection": true }, { "name": "CustomerRepresentativeAssignments", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." } }, "put": { "operationId": "aurax-bff-redirect-edit-corporate-customer-ui-bpm", "tags": [ "corporate-customers" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-edit-corporate-customer-ui-bpm", "description": "Request and response fields are declared on the routing target `edit-corporate-customer-ui-bpm`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "activityLicenseNumber": { "type": "string", "x-aura-field-code": "activityLicenseNumber" }, "addresses": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "addressFields": { "type": "array", "items": { "type": "object", "properties": { "fieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "addressTypeFieldId" }, "fieldValue": { "type": "string", "x-aura-field-code": "addressTypeFieldValue" } }, "required": [ "fieldId", "fieldValue" ], "x-aura-field-code": "addressFields" } }, "addressId": { "type": "string", "format": "uuid", "x-aura-field-code": "addressId" }, "addressName": { "type": "string", "x-aura-field-code": "addressName" }, "addressType": { "type": "integer", "format": "int32", "x-aura-field-code": "addressType" }, "addressTypeId": { "type": "string", "format": "uuid", "x-aura-field-code": "addressTypeId" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" } }, "required": [ "_rowStatus", "addressFields", "addressType", "addressTypeId", "isContact", "isDefault" ], "x-aura-field-code": "addresses" } }, "authorities": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "_rowStatus" }, "authorityType": { "type": "integer", "format": "int32", "x-aura-field-code": "authorityType" }, "description": { "type": "string", "x-aura-field-code": "description" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerAuthorityId" }, "startDate": { "type": "string", "format": "date-time", "x-aura-field-code": "startDate" }, "toCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "toCustomerId" } }, "x-aura-field-code": "authorities" } }, "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "citizenidType": { "type": "integer", "format": "int32", "x-aura-field-code": "citizenidType" }, "corporateCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateCustomerId" }, "createdOrganizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "createdOrganizationId" }, "customerSubType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerSubType" }, "customerType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerType" }, "emails": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "email": { "type": "string", "x-aura-field-code": "email" }, "emailId": { "type": "string", "format": "uuid", "x-aura-field-code": "emailId" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "isVerified": { "type": "boolean", "x-aura-field-code": "isVerified" }, "mailId": { "type": "string", "format": "uuid", "x-aura-field-code": "mailId" } }, "required": [ "_rowStatus", "email", "isContact", "isDefault" ], "x-aura-field-code": "emails" } }, "establishCountryDivisionId": { "type": "integer", "format": "int32", "x-aura-field-code": "establishCountryDivisionId" }, "establishCountryId": { "type": "integer", "format": "int32", "x-aura-field-code": "establishCountryId" }, "establishDate": { "type": "string", "format": "date", "x-aura-field-code": "establishDate" }, "freeZone": { "type": "integer", "format": "int32", "x-aura-field-code": "freeZone" }, "fullName": { "type": "string", "x-aura-field-code": "fullName" }, "isFreeZoneCustomer": { "type": "boolean", "x-aura-field-code": "isFreeZoneCustomer" }, "isSeller": { "type": "boolean", "x-aura-field-code": "isSeller" }, "legalOrganizationType": { "type": "integer", "format": "int32", "x-aura-field-code": "legalOrganizationType" }, "licenseEndDate": { "type": "string", "format": "date", "x-aura-field-code": "licenseEndDate" }, "mainOrganizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "mainOrganizationId" }, "naceId": { "type": "string", "format": "uuid", "x-aura-field-code": "naceId" }, "onboardedOrganizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "onboardedOrganizationId" }, "organizationType": { "type": "integer", "format": "int32", "x-aura-field-code": "organizationType" }, "phones": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "phoneId": { "type": "string", "format": "uuid", "x-aura-field-code": "phoneId" }, "phoneNumber": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true }, "phoneType": { "type": "integer", "format": "int32", "x-aura-field-code": "phoneType" } }, "required": [ "_rowStatus", "isContact", "isDefault", "phoneNumber", "phoneType" ], "x-aura-field-code": "phones" } }, "registryOfficeCountryDivisionId": { "type": "integer", "format": "int32", "x-aura-field-code": "registryOfficeCountryDivisionId" }, "registryOfficeCountryId": { "type": "integer", "format": "int32", "x-aura-field-code": "registryOfficeCountryId" }, "relations": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "_rowStatus" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerRelationshipId" }, "relationType": { "type": "integer", "format": "int32", "x-aura-field-code": "relationType" }, "shareHolders": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "_rowStatus" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerShareholderId" }, "shareRate": { "type": "number", "format": "decimal", "x-aura-field-code": "shareRate" }, "startDate": { "type": "string", "format": "date-time", "x-aura-field-code": "startDate" } }, "x-aura-field-code": "shareHolders" } }, "toCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "toCustomerId" } }, "x-aura-field-code": "relations" } }, "sectorNaceId": { "type": "string", "format": "uuid", "x-aura-field-code": "sectorNaceId" }, "shortName": { "type": "string", "x-aura-field-code": "shortName" }, "subOrganizationType": { "type": "integer", "format": "int32", "x-aura-field-code": "subOrganizationType" }, "taxOfficeId": { "type": "string", "format": "uuid", "x-aura-field-code": "taxOfficeId" }, "title": { "type": "string", "x-aura-field-code": "title" }, "tradeRegisterNumber": { "type": "string", "x-aura-field-code": "tradeRegisterNumber" } }, "required": [ "citizenid", "citizenidType", "createdOrganizationId", "customerSubType", "customerType", "fullName", "mainOrganizationId", "onboardedOrganizationId" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 33, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-edit-corporate-customer-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "corporate-customers/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/corporate-scores": { "get": { "operationId": "aurax-bff-redirect-get-corporate-score-list", "tags": [ "corporate-scores" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-corporate-score-list", "description": "Request and response fields are declared on the routing target `get-corporate-score-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateScoreId" }, "score": { "type": "integer", "format": "int32", "x-aura-field-code": "corporateScore" }, "scoreDate": { "type": "string", "format": "date", "x-aura-field-code": "scoreDate" }, "scoreType": { "type": "integer", "format": "int32", "x-aura-field-code": "scoreType" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-corporate-score-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "corporate-scores", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-corporate-score-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "CorporateScoreDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ScoreType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ScoreDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "Score", "declared_type": "int?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." } }, "post": { "operationId": "aurax-bff-redirect-create-corporate-score", "tags": [ "corporate-scores" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-create-corporate-score", "description": "Request and response fields are declared on the routing target `create-corporate-score`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "score": { "type": "integer", "format": "int32", "x-aura-field-code": "corporateScore" }, "scoreDate": { "type": "string", "format": "date", "x-aura-field-code": "scoreDate" }, "scoreType": { "type": "integer", "format": "int32", "x-aura-field-code": "scoreType" } }, "required": [ "customerId", "score", "scoreDate", "scoreType" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 4, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-corporate-score", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "corporate-scores", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "ScoreType", "declared_type": null, "nullable": true, "collection": false }, { "name": "ScoreDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "Score", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "command-id", "note": "The route returns `AuraCommandDto`, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, `Id`, of type `Guid`. A caller gets a JSON OBJECT with one field, not a bare value. The field is `id` on the wire.", "declared_type": "AuraCommandDto", "envelopes": [ "AuraCommandDto" ], "payload": "Guid", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false, "wire_name": "id", "wire_name_basis": "framework-naming-policy" } ], "naming": "Member names are the service's declaration names.", "synthesized": true }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/corporate-scores/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-corporate-score", "tags": [ "corporate-scores" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-delete-corporate-score", "description": "Request and response fields are declared on the routing target `delete-corporate-score`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateScoreId" } } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-corporate-score", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "corporate-scores/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ALLTMNT_66", "status": 400, "message": { "en": "Corporate score not found for the given ID: {0}.", "tr": "Verilen ID için kurumsal skor bulunamadı: {0}." }, "message_available": true, "constant_name": "CORPORATE_SCORE_NOT_FOUND" } ] } }, "get": { "operationId": "aurax-bff-redirect-get-corporate-score-by-id", "tags": [ "corporate-scores" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-corporate-score-by-id", "description": "Request and response fields are declared on the routing target `get-corporate-score-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateScoreId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateScoreId" }, "score": { "type": "integer", "format": "int32", "x-aura-field-code": "corporateScore" }, "scoreDate": { "type": "string", "format": "date", "x-aura-field-code": "scoreDate" }, "scoreType": { "type": "integer", "format": "int32", "x-aura-field-code": "scoreType" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-corporate-score-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "corporate-scores/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "CorporateScoreDto", "payload": "CorporateScoreDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ScoreType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ScoreDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "Score", "declared_type": "int?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ALLTMNT_66", "status": 400, "message": { "en": "Corporate score not found for the given ID: {0}.", "tr": "Verilen ID için kurumsal skor bulunamadı: {0}." }, "message_available": true, "constant_name": "CORPORATE_SCORE_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-corporate-score", "tags": [ "corporate-scores" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-update-corporate-score", "description": "Request and response fields are declared on the routing target `update-corporate-score`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateScoreId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "score": { "type": "integer", "format": "int32", "x-aura-field-code": "corporateScore" }, "scoreDate": { "type": "string", "format": "date", "x-aura-field-code": "scoreDate" }, "scoreType": { "type": "integer", "format": "int32", "x-aura-field-code": "scoreType" } }, "required": [ "customerId", "score", "scoreDate", "scoreType" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 4, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-corporate-score", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "corporate-scores/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "ScoreType", "declared_type": null, "nullable": true, "collection": false }, { "name": "ScoreDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "Score", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ALLTMNT_66", "status": 400, "message": { "en": "Corporate score not found for the given ID: {0}.", "tr": "Verilen ID için kurumsal skor bulunamadı: {0}." }, "message_available": true, "constant_name": "CORPORATE_SCORE_NOT_FOUND" } ] } } }, "/countries": { "get": { "operationId": "aurax-bff-redirect-get-country-list", "tags": [ "countries" ], "summary": "aurax-bff-redirect-get-country-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-country-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "countries", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "CountryDto", "collection": true, "members": [ { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Alpha2", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Alpha3", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Flag", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Numeric", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Translations", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-country-list", "target_dapr_app_id": "core-service", "target_route": "countries", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/countries/address-types": { "get": { "operationId": "aurax-bff-redirect-get-country-address-type-list", "tags": [ "countries" ], "summary": "aurax-bff-redirect-get-country-address-type-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-country-address-type-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "countries/address-types", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "CountryAddressTypeDto", "collection": true, "members": [ { "name": "CountryId", "declared_type": "int", "nullable": false, "collection": false }, { "name": "AddressType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "SequenceNumber", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-country-address-type-list", "target_dapr_app_id": "core-service", "target_route": "countries/address-types", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/countries/address-types/address-items": { "get": { "operationId": "aurax-bff-redirect-get-country-address-item-list", "tags": [ "countries" ], "summary": "aurax-bff-redirect-get-country-address-item-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-country-address-item-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "countries/address-types/address-items", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "CountryAddressItemDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CountryAddressTypeId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ParentCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ParentCountryAddressItemId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CountryId", "declared_type": "int", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-country-address-item-list", "target_dapr_app_id": "core-service", "target_route": "countries/address-types/address-items", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_CORE_3", "status": 400, "message": { "ar": "البلد غير موجود.", "en": "Country cannot be found.", "tr": "Ülke bulunamadı." }, "message_available": true, "constant_name": "COUNTRY_IS_NOT_FOUND" } ] } } }, "/countries/address-types/address-items/with-codes": { "get": { "operationId": "aurax-bff-get-country-address-item-list", "tags": [ "countries" ], "summary": "aurax-bff-get-country-address-item-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-get-country-address-item-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "countries/address-types/address-items/with-codes", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "PagedResultDto", "envelopes": [ "PagedResultDto" ], "payload": "GetCountryAddressItemListDto", "collection": false, "members": [ { "name": "Id", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CountryAddressTypeId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ParentCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ParentCountryAddressItemId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CountryId", "declared_type": "int", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/countries/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-country", "tags": [ "countries" ], "summary": "aurax-bff-redirect-delete-country", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-country", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "countries/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "forwarded": { "service_code": "delete-country", "target_dapr_app_id": "core-service", "target_route": "countries/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_CORE_3", "status": 400, "message": { "ar": "البلد غير موجود.", "en": "Country cannot be found.", "tr": "Ülke bulunamadı." }, "message_available": true, "constant_name": null } ] } } }, "/countries/{id}/address-types": { "get": { "operationId": "aurax-bff-redirect-get-country-address-type-list-by-country-id", "tags": [ "countries" ], "summary": "aurax-bff-redirect-get-country-address-type-list-by-country-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-country-address-type-list-by-country-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "countries/{id}/address-types", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "CountryAddressTypeDto", "collection": true, "members": [ { "name": "CountryId", "declared_type": "int", "nullable": false, "collection": false }, { "name": "AddressType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "SequenceNumber", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-country-address-type-list-by-country-id", "target_dapr_app_id": "core-service", "target_route": "countries/{id}/address-types", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-country-address-type-create-ui-bpm", "tags": [ "countries" ], "summary": "aurax-bff-redirect-country-address-type-create-ui-bpm", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-country-address-type-create-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "countries/{id}/address-types", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "AddressType", "declared_type": null, "nullable": false, "collection": false }, { "name": "SequenceNumber", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/countries/{id}/address-types/{addressTypeId}": { "delete": { "operationId": "aurax-bff-redirect-country-address-type-delete-ui-bpm", "tags": [ "countries" ], "summary": "aurax-bff-redirect-country-address-type-delete-ui-bpm", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "addressTypeId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-country-address-type-delete-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "countries/{id}/address-types/{addressTypeId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "AddressTypeId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "get": { "operationId": "aurax-bff-redirect-get-country-address-type-by-id", "tags": [ "countries" ], "summary": "aurax-bff-redirect-get-country-address-type-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "addressTypeId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-country-address-type-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "countries/{id}/address-types/{addressTypeId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "AddressTypeId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "CountryAddressTypeDto", "payload": "CountryAddressTypeDto", "collection": false, "members": [ { "name": "CountryId", "declared_type": "int", "nullable": false, "collection": false }, { "name": "AddressType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "SequenceNumber", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-country-address-type-by-id", "target_dapr_app_id": "core-service", "target_route": "countries/{id}/address-types/{addressTypeId}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_CORE_113", "status": 400, "message": { "ar": "معرف نوع عنوان البلد غير موجود.", "en": "Country address type cannot not be found.", "tr": "Ülke adres türü bulunamadı." }, "message_available": true, "constant_name": "COUNTRY_ADDRESS_TYPE_IS_NOT_FOUND" }, { "code": "ERR_CORE_3", "status": 400, "message": { "ar": "البلد غير موجود.", "en": "Country cannot be found.", "tr": "Ülke bulunamadı." }, "message_available": true, "constant_name": "COUNTRY_IS_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-country-address-type-edit-ui-bpm", "tags": [ "countries" ], "summary": "aurax-bff-redirect-country-address-type-edit-ui-bpm", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "addressTypeId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-country-address-type-edit-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "countries/{id}/address-types/{addressTypeId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "AddressTypeId", "declared_type": null, "nullable": false, "collection": false }, { "name": "AddressType", "declared_type": null, "nullable": false, "collection": false }, { "name": "SequenceNumber", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/countries/{id}/division-codes": { "get": { "operationId": "aurax-bff-get-country-division-list", "tags": [ "countries" ], "summary": "aurax-bff-get-country-division-list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-get-country-division-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "countries/{id}/division-codes", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "PagedResultDto", "envelopes": [ "PagedResultDto" ], "payload": "GetCountryDivisionListDto", "collection": false, "members": [ { "name": "Id", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/countries/{id}/divisions": { "get": { "operationId": "aurax-bff-redirect-get-country-division-list", "tags": [ "countries" ], "summary": "aurax-bff-redirect-get-country-division-list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-country-division-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "countries/{id}/divisions", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "CountryDivisionDto", "collection": true, "members": [ { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Type", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ParentDivisionCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Alpha2", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DivisionCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Translations", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-country-division-list", "target_dapr_app_id": "core-service", "target_route": "countries/{id}/divisions", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/countries/{id}/divisions/{divisionId}": { "get": { "operationId": "aurax-bff-redirect-get-country-division-by-id", "tags": [ "countries" ], "summary": "aurax-bff-redirect-get-country-division-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "divisionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-country-division-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "countries/{id}/divisions/{divisionId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "DivisionId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "CountryDivisionDto", "payload": "CountryDivisionDto", "collection": false, "members": [ { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Type", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ParentDivisionCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Alpha2", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DivisionCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Translations", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-country-division-by-id", "target_dapr_app_id": "core-service", "target_route": "countries/{id}/divisions/{divisionId}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_CORE_5", "status": 400, "message": { "ar": "لم يتم العثور على تقسيم البلاد.", "en": "Country Division cannot be found.", "tr": "Ülke Bölümü bulunamadı." }, "message_available": true, "constant_name": null } ] } } }, "/create-address-email-emlak": { "post": { "operationId": "aurax-bff-create-address-email-emlak", "tags": [ "create-address-email-emlak" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-create-address-email-emlak", "description": "Request and response fields are declared on the routing target `create-address-email-emlak`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "type": "object", "properties": { "addressField": { "type": "object", "properties": { "addressOpenText": { "type": "string", "x-aura-field-code": "addressOpenText", "x-aura-maskable": true }, "city": { "type": "string", "x-aura-field-code": "city", "x-aura-maskable": true }, "district": { "type": "string", "x-aura-field-code": "district", "x-aura-maskable": true }, "title": { "type": "string", "x-aura-field-code": "title" } }, "x-aura-field-code": "addressField" }, "addressType": { "type": "integer", "format": "int32", "x-aura-field-code": "addressType" }, "isCardDeliveryAddress": { "type": "boolean", "x-aura-field-code": "isCardDeliveryAddress" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" } }, "x-aura-field-code": "addresses" } }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "email": { "type": "string", "x-aura-field-code": "email" } }, "required": [ "email" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 3, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-create-address-email-emlak", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "create-address-email-emlak", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/create-allotment-assignment-request-bpmn": { "post": { "operationId": "aurax-bff-redirect-create-allotment-assignment-request-bpmn", "tags": [ "create-allotment-assignment-request-bpmn" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-create-allotment-assignment-request-bpmn", "description": "Request and response fields are declared on the routing target `create-allotment-assignment-request-bpmn`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "corporateAssignmentFields": { "type": "string", "x-aura-field-code": "corporateAssignmentFields" }, "corporateAssignmentRequestId": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateAssignmentRequestId" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "dmsId": { "type": "string", "format": "uuid", "x-aura-field-code": "dmsId" } }, "required": [ "customerId", "dmsId" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 4, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-allotment-assignment-request-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "create-allotment-assignment-request-bpmn", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/create-customer-administrative-follow-bpmn": { "post": { "operationId": "aurax-bff-create-customer-administrative-follow-bpmn", "tags": [ "create-customer-administrative-follow-bpmn" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-create-customer-administrative-follow-bpmn", "description": "Request and response fields are declared on the routing target `create-customer-administrative-follow-bpmn`; this entry declares none of its own.", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-create-customer-administrative-follow-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "create-customer-administrative-follow-bpmn", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/create-customer-audit": { "post": { "operationId": "aurax-bff-redirect-create-customer-audit", "tags": [ "create-customer-audit" ], "summary": "aurax-bff-redirect-create-customer-audit", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-customer-audit", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "create-customer-audit", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/create-customer-emlak": { "post": { "operationId": "aurax-bff-create-customer-emlak", "tags": [ "create-customer-emlak" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-create-customer-emlak", "description": "Request and response fields are declared on the routing target `create-customer-emlak`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "consents": { "type": "array", "items": { "type": "object", "x-aura-field-code": "consents" } }, "customerTaxpayers": { "type": "array", "items": { "type": "object", "properties": { "countryId": { "type": "integer", "format": "int32", "x-aura-field-code": "countryId" }, "taxNumber": { "type": "string", "x-aura-field-code": "taxNumber" }, "taxpayerType": { "type": "integer", "format": "int32", "x-aura-field-code": "taxpayerType" } }, "x-aura-field-code": "customerTaxpayers" } }, "monthlyIncome": { "type": "integer", "format": "int32", "x-aura-field-code": "monthlyIncome" }, "occupations": { "type": "array", "items": { "type": "object", "properties": { "fieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "occupationTypeFieldId" }, "typeId": { "type": "string", "format": "uuid", "x-aura-field-code": "occupationTypeId" } }, "required": [ "fieldId", "typeId" ], "x-aura-field-code": "occupations" } }, "phoneNumber": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true } }, "required": [ "citizenid", "monthlyIncome", "occupations", "phoneNumber" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 6, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "customerNumber": { "type": "string", "x-aura-field-code": "customerNumber" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "customerNumber": { "type": "string", "x-aura-field-code": "customerNumber" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "customerNumber": { "type": "string", "x-aura-field-code": "customerNumber" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-create-customer-emlak", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "create-customer-emlak", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/create-customer-follow-for-follow-loan-bpmn": { "post": { "operationId": "aurax-bff-create-customer-follow-for-follow-loan-bpmn", "tags": [ "create-customer-follow-for-follow-loan-bpmn" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-create-customer-follow-for-follow-loan-bpmn", "description": "Request and response fields are declared on the routing target `create-customer-follow-for-follow-loan-bpmn`; this entry declares none of its own.", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-create-customer-follow-for-follow-loan-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "create-customer-follow-for-follow-loan-bpmn", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/create-customer-legal-follow-five-scheduler-bpmn": { "post": { "operationId": "aurax-bff-create-customer-legal-follow-five-scheduler-bpmn", "tags": [ "create-customer-legal-follow-five-scheduler-bpmn" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-create-customer-legal-follow-five-scheduler-bpmn", "description": "Request and response fields are declared on the routing target `create-customer-legal-follow-five-scheduler-bpmn`; this entry declares none of its own.", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-create-customer-legal-follow-five-scheduler-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "create-customer-legal-follow-five-scheduler-bpmn", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/create-customer-legal-follow-one-bpmn": { "post": { "operationId": "aurax-bff-create-customer-legal-follow-one-bpmn", "tags": [ "create-customer-legal-follow-one-bpmn" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-create-customer-legal-follow-one-bpmn", "description": "Request and response fields are declared on the routing target `create-customer-legal-follow-one-bpmn`; this entry declares none of its own.", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-create-customer-legal-follow-one-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "create-customer-legal-follow-one-bpmn", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/create-customer-legal-follow-six-scheduler-bpmn": { "post": { "operationId": "aurax-bff-create-customer-legal-follow-six-scheduler-bpmn", "tags": [ "create-customer-legal-follow-six-scheduler-bpmn" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-create-customer-legal-follow-six-scheduler-bpmn", "description": "Request and response fields are declared on the routing target `create-customer-legal-follow-six-scheduler-bpmn`; this entry declares none of its own.", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-create-customer-legal-follow-six-scheduler-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "create-customer-legal-follow-six-scheduler-bpmn", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/create-customer-loan-collateral-pledge-ui-bpmn": { "post": { "operationId": "aurax-bff-redirect-create-customer-loan-collateral-pledge-ui-bpmn", "tags": [ "create-customer-loan-collateral-pledge-ui-bpmn" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-create-customer-loan-collateral-pledge-ui-bpmn", "description": "Request and response fields are declared on the routing target `create-customer-loan-collateral-pledge-ui-bpmn`; this entry declares none of its own.\n\nDeclared as Route-bound but absent from the route template, so not sendable: dmsId.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "collateralTypeId": { "type": "string", "format": "uuid", "x-aura-field-code": "collateralTypeId" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "description": { "type": "string", "x-aura-field-code": "collateralDescription" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "fieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "fieldId" }, "fieldValue": { "type": "string", "x-aura-field-code": "fieldValue" }, "fields": { "type": "array", "items": { "type": "object", "x-aura-field-code": "fields" } }, "maturityDate": { "type": "string", "format": "date-time", "x-aura-field-code": "maturityDate" }, "name": { "type": "string", "x-aura-field-code": "collateralName" }, "notaryPledgeNumber": { "type": "string", "x-aura-field-code": "notaryPledgeNumber" }, "notaryTransactionNumber": { "type": "string", "x-aura-field-code": "notaryTransactionNumber" }, "removalDate": { "type": "string", "format": "date-time", "x-aura-field-code": "removalDate" }, "startDate": { "type": "string", "format": "date-time", "x-aura-field-code": "startDate" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "status" }, "usableRate": { "type": "number", "format": "decimal", "x-aura-field-code": "usableRate" } }, "required": [ "amount", "collateralTypeId", "currencyNumber", "customerId", "description", "maturityDate", "name", "notaryPledgeNumber", "startDate", "status", "usableRate" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 17, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-customer-loan-collateral-pledge-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "create-customer-loan-collateral-pledge-ui-bpmn", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/create-denomination-bpmn": { "post": { "operationId": "aurax-bff-redirect-create-denomination-bpmn", "tags": [ "create-denomination-bpmn" ], "summary": "aurax-bff-redirect-create-denomination-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-denomination-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "create-denomination-bpmn", "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/create-easy-address": { "post": { "operationId": "aurax-bff-service-dynamic-create-easy-address-bpm", "tags": [ "create-easy-address" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-create-easy-address-bpm", "description": "Request and response fields are declared on the routing target `create-easy-address-bpm`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "addressType": { "type": "integer", "format": "int32", "x-aura-field-code": "addressType" }, "addressTypeCode": { "type": "string", "x-aura-field-code": "addressTypeCode" }, "addressTypeValue": { "type": "string", "x-aura-field-code": "addressTypeValue" }, "iban": { "type": "string", "x-aura-field-code": "iban" } }, "required": [ "addressType", "addressTypeCode", "addressTypeValue", "iban" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 4, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-create-easy-address-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "create-easy-address", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/create-eledger-request-bpmn": { "post": { "operationId": "aurax-bff-redirect-create-eledger-request-bpmn", "tags": [ "create-eledger-request-bpmn" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-create-eledger-request-bpmn", "description": "Request and response fields are declared on the routing target `create-eledger-request-bpmn`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "beginDate": { "type": "string", "format": "date", "x-aura-field-code": "eledgerRequestBeginDate" }, "description": { "type": "string", "x-aura-field-code": "eledgerRequestDescription" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "eledgerRequestEndDate" }, "fileFormat": { "type": "integer", "format": "int32", "x-aura-field-code": "fileFormat" } }, "required": [ "beginDate", "description", "endDate", "fileFormat" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 4, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "eledgerRequestId" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "eledgerRequestId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "eledgerRequestId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-eledger-request-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "create-eledger-request-bpmn", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/create-general-provision-for-loan-scheduler-bpmn": { "post": { "operationId": "aurax-bff-create-general-provision-for-loan-scheduler-bpmn", "tags": [ "create-general-provision-for-loan-scheduler-bpmn" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-create-general-provision-for-loan-scheduler-bpmn", "description": "Request and response fields are declared on the routing target `create-general-provision-for-loan-scheduler-bpmn`; this entry declares none of its own.", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-create-general-provision-for-loan-scheduler-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "create-general-provision-for-loan-scheduler-bpmn", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/create-loan-for-corporate-foreign-trade-channel-ui-bpmn": { "post": { "operationId": "aurax-bff-redirect-create-loan-for-corporate-foreign-trade-channel-ui-bpmn", "tags": [ "create-loan-for-corporate-foreign-trade-channel-ui-bpmn" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-create-loan-for-corporate-foreign-trade-channel-ui-bpmn", "x-aura-incomplete-contract": { "note": "Presence of this extension means the request and response schemas on this operation are known to be incomplete. Absence means no declared field was dropped for this reason — it is not a claim that the catalog is otherwise complete." }, "description": "Request and response fields are declared on the routing target `create-loan-for-corporate-foreign-trade-channel-ui-bpmn`; this entry declares none of its own.\n\nINCOMPLETE CONTRACT. The catalog declares 7 request field(s) that this document could NOT place and does not show: the catalog parents this field to a row belonging to a DIFFERENT service, so it is a child of a node that is not part of this contract. So the properties and any `required` array below are a SUBSET of what the catalog declares, not the whole of it. They are dropped rather than re-attached because placing them would mean guessing which node they belong under, and this document does not guess. See `x-aura-incomplete-contract` for the field names.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "accountId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountId" }, "accountNumber": { "type": "string", "x-aura-field-code": "accountNumber" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "dmsId": { "type": "string", "format": "uuid", "x-aura-field-code": "dmsId" }, "externalVendorId": { "type": "string", "format": "uuid", "x-aura-field-code": "externalVendorId" }, "firstInstallmentDate": { "type": "string", "format": "date-time", "x-aura-field-code": "firstInstallmentDate" }, "installmentCount": { "type": "integer", "format": "int32", "x-aura-field-code": "installmentCount" }, "invoices": { "type": "array", "items": { "type": "object", "x-aura-field-code": "invoices" } }, "loanCurrencyType": { "type": "integer", "format": "int32", "x-aura-field-code": "loanCurrencyType" }, "loanProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanProductId" }, "metalCode": { "type": "string", "x-aura-field-code": "metalCode" }, "poolDefinitionId": { "type": "string", "format": "uuid", "x-aura-field-code": "poolDefinitionId" }, "poolDefinitionRateId": { "type": "string", "format": "uuid", "x-aura-field-code": "poolDefinitionRateId" }, "tempLoanId": { "type": "string", "format": "uuid", "x-aura-field-code": "tempLoanId" }, "unitPrice": { "type": "number", "format": "decimal", "x-aura-field-code": "unitPrice" }, "vendorAccountId": { "type": "string", "format": "uuid", "x-aura-field-code": "vendorAccountId" }, "weight": { "type": "number", "x-aura-field-code": "weight" } }, "required": [ "amount", "customerId", "loanCurrencyType", "loanProductId" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 18, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "loanId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanId" }, "virtualIban": { "type": "string", "x-aura-field-code": "virtualIban" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "loanId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanId" }, "virtualIban": { "type": "string", "x-aura-field-code": "virtualIban" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "loanId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanId" }, "virtualIban": { "type": "string", "x-aura-field-code": "virtualIban" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-loan-for-corporate-foreign-trade-channel-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "create-loan-for-corporate-foreign-trade-channel-ui-bpmn", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/create-loan-invoice-ui-bpmn": { "post": { "operationId": "aurax-bff-redirect-create-loan-invoice-ui-bpmn", "tags": [ "create-loan-invoice-ui-bpmn" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-create-loan-invoice-ui-bpmn", "description": "Request and response fields are declared on the routing target `create-loan-invoice-ui-bpmn`; this entry declares none of its own.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "invoices": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "_rowStatus" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "invoiceId" }, "invoiceAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "invoiceAmount" }, "invoiceDate": { "type": "string", "format": "date-time", "x-aura-field-code": "invoiceDate" }, "invoiceIssuer": { "type": "string", "x-aura-field-code": "invoiceIssuer" }, "isOfficialInvoice": { "type": "boolean", "x-aura-field-code": "isOfficialInvoice" }, "loanId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanId" }, "serialNumber": { "type": "string", "x-aura-field-code": "serialNumber" }, "shipmentDate": { "type": "string", "format": "date-time", "x-aura-field-code": "shipmentDate" }, "usingInvoiceAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "usingInvoiceAmount" } }, "x-aura-field-code": "invoices" } } } } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-loan-invoice-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "create-loan-invoice-ui-bpmn", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/create-potential-corporate-customer-ui-bpm": { "post": { "operationId": "aurax-bff-redirect-create-potential-corporate-customer-ui-bpm", "tags": [ "create-potential-corporate-customer-ui-bpm" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-create-potential-corporate-customer-ui-bpm", "description": "Request and response fields are declared on the routing target `create-potential-corporate-customer-ui-bpm`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "citizenidType": { "type": "integer", "format": "int32", "x-aura-field-code": "citizenidType" }, "createdOrganizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "createdOrganizationId" }, "fullName": { "type": "string", "x-aura-field-code": "fullName" }, "mainOrganizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "mainOrganizationId" }, "onboardedDate": { "type": "string", "format": "date", "x-aura-field-code": "customerOnboardedDate" }, "onboardedOrganizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "onboardedOrganizationId" }, "phones": { "type": "array", "items": { "type": "object", "properties": { "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "phoneNumber": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true }, "phoneType": { "type": "integer", "format": "int32", "x-aura-field-code": "phoneType" } }, "required": [ "isDefault", "phoneNumber", "phoneType" ], "x-aura-field-code": "phones" } } }, "required": [ "citizenid", "citizenidType", "createdOrganizationId", "mainOrganizationId", "onboardedOrganizationId", "phones" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 8, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "customerNumber": { "type": "string", "x-aura-field-code": "customerNumber" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "customerNumber": { "type": "string", "x-aura-field-code": "customerNumber" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "customerNumber": { "type": "string", "x-aura-field-code": "customerNumber" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-potential-corporate-customer-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "create-potential-corporate-customer-ui-bpm", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/create-restructure-ui-bpmn": { "post": { "operationId": "aurax-bff-create-restructure-ui-bpmn", "tags": [ "create-restructure-ui-bpmn" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-create-restructure-ui-bpmn", "description": "Request and response fields are declared on the routing target `create-restructure-ui-bpmn`; this entry declares none of its own.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "accountId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountId" }, "currencyType": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyType" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "dmsId": { "type": "string", "format": "uuid", "x-aura-field-code": "dmsId" }, "firstInstallmentDate": { "type": "string", "format": "date-time", "x-aura-field-code": "firstInstallmentDate" }, "fixedRate": { "type": "number", "format": "decimal", "x-aura-field-code": "fixedRate" }, "installmentCount": { "type": "integer", "format": "int32", "x-aura-field-code": "installmentCount" }, "isFixed": { "type": "boolean", "x-aura-field-code": "isFixed" }, "loanId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanId" }, "operationType": { "type": "integer", "format": "int32", "x-aura-field-code": "operationType" }, "restructureLoanAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "restructureLoanAmount" }, "restructureLoanProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "restructureLoanProductId" } } } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 12, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "loanNumber": { "type": "string", "x-aura-field-code": "loanNumber" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "loanNumber": { "type": "string", "x-aura-field-code": "loanNumber" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "loanNumber": { "type": "string", "x-aura-field-code": "loanNumber" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-create-restructure-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "create-restructure-ui-bpmn", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/create-special-provision-for-loan-scheduler-bpmn": { "post": { "operationId": "aurax-bff-create-special-provision-for-loan-scheduler-bpmn", "tags": [ "create-special-provision-for-loan-scheduler-bpmn" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-create-special-provision-for-loan-scheduler-bpmn", "description": "Request and response fields are declared on the routing target `create-special-provision-for-loan-scheduler-bpmn`; this entry declares none of its own.", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-create-special-provision-for-loan-scheduler-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "create-special-provision-for-loan-scheduler-bpmn", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/create-vendor-disbursement-without-confirmation-ui-bpmn": { "post": { "operationId": "aurax-bff-redirect-create-vendor-disbursement-without-confirmation-ui-bpmn", "tags": [ "create-vendor-disbursement-without-confirmation-ui-bpmn" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-create-vendor-disbursement-without-confirmation-ui-bpmn", "description": "Request and response fields are declared on the routing target `create-vendor-disbursement-without-confirmation-ui-bpmn`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "vendorDisbursementAmount" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "exchangeRate": { "type": "number", "format": "decimal", "x-aura-field-code": "exchangeRate" }, "externalVendorAccountCurrency": { "type": "string", "x-aura-field-code": "externalVendorAccountCurrency" }, "externalVendorAccountId": { "type": "string", "format": "uuid", "x-aura-field-code": "externalVendorAccountId" }, "externalVendorId": { "type": "string", "format": "uuid", "x-aura-field-code": "externalVendorId" }, "internalVendorAccountCurrency": { "type": "string", "x-aura-field-code": "internalVendorAccountCurrency" }, "internalVendorAccountId": { "type": "string", "format": "uuid", "x-aura-field-code": "internalVendorAccountId" }, "internalVendorId": { "type": "string", "format": "uuid", "x-aura-field-code": "internalVendorId" }, "loanId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanId" }, "paymentType": { "type": "integer", "format": "int32", "x-aura-field-code": "paymentType" } }, "required": [ "amount", "currencyNumber", "exchangeRate", "loanId" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 12, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "accountingEntryId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryId" }, "vendorDisbursementId": { "type": "string", "format": "uuid", "x-aura-field-code": "vendorDisbursementId" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "accountingEntryId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryId" }, "vendorDisbursementId": { "type": "string", "format": "uuid", "x-aura-field-code": "vendorDisbursementId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "accountingEntryId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryId" }, "vendorDisbursementId": { "type": "string", "format": "uuid", "x-aura-field-code": "vendorDisbursementId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-vendor-disbursement-without-confirmation-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "create-vendor-disbursement-without-confirmation-ui-bpmn", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/create-verify-enqura-emlak": { "post": { "operationId": "aurax-bff-create-verify-enqura-emlak", "tags": [ "create-verify-enqura-emlak" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-create-verify-enqura-emlak", "description": "Request and response fields are declared on the routing target `create-verify-enqura-emlak`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" } }, "required": [ "customerId" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-create-verify-enqura-emlak", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "create-verify-enqura-emlak", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/create-virtual-iban-bpm": { "post": { "operationId": "aurax-bff-redirect-create-virtual-iban-bpm", "tags": [ "create-virtual-iban-bpm" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-create-virtual-iban-bpm", "description": "Request and response fields are declared on the routing target `create-virtual-iban-bpm`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" } }, "required": [ "id" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "virtualIban": { "type": "string", "x-aura-field-code": "virtualIban" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "virtualIban": { "type": "string", "x-aura-field-code": "virtualIban" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "virtualIban": { "type": "string", "x-aura-field-code": "virtualIban" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-virtual-iban-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "create-virtual-iban-bpm", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/credit-bureau-infos/create-krs-risk-report": { "post": { "operationId": "aurax-bff-redirect-krs-report", "tags": [ "credit-bureau-infos" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-krs-repot", "description": "Invokes the `aurax-bff-redirect-krs-report` service definition through `POST /credit-bureau-infos/create-krs-risk-report`.\n\nRequest and response fields are declared on the routing target `create-krs-report`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "citizenId": { "type": "string", "x-aura-field-code": "citizenId" }, "citizenIdType": { "type": "integer", "format": "int32", "x-aura-field-code": "citizenidType" } }, "required": [ "citizenId" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 2, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-krs-report", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "credit-bureau-infos/create-krs-risk-report", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "structure", "declared_type": "ExternalServiceResultDto", "envelopes": [ "ExternalServiceResultDto" ], "payload": "KrsReportDto", "collection": false, "members": [ { "name": "CitizenId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CitizenIdType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ReferenceNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Kkb1StAccTOpenDateDiff", "declared_type": "int", "nullable": false, "collection": false }, { "name": "KkbFirstEmpStartTimeSince", "declared_type": "int", "nullable": false, "collection": false }, { "name": "KkbLastEmpStartTimeSince", "declared_type": "int", "nullable": false, "collection": false }, { "name": "IsLastQuery", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "ExternalServiceResultId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "QueryDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "JsonData", "declared_type": "JsonNode", "nullable": false, "collection": false }, { "name": "KrsRiskReportPersonalDetails", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_INTGRTN_52", "status": 400, "message": { "ar": "لا يجب أن يكون رقم المواطن فارغًا.", "en": "Citizen Number must not be empty.", "tr": "Vatandaşlık numarası boş olmamalıdır." }, "message_available": true, "constant_name": "CITIZENID_MUST_NOT_BE_EMTPY" } ] } } }, "/credit-bureau-infos/individual-risk-report": { "post": { "operationId": "aurax-bff-redirect-individual-risk-report", "tags": [ "credit-bureau-infos" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-individual-risk-report", "description": "Request and response fields are declared on the routing target `individual-risk-report`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "inputValues": { "type": "object", "x-aura-field-code": "inputValues" } }, "required": [ "inputValues" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-individual-risk-report", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "credit-bureau-infos/individual-risk-report", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "InputValues", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ExternalServiceResultDto", "envelopes": [ "ExternalServiceResultDto" ], "payload": "IndividualRiskReportDto", "collection": false, "members": [ { "name": "IlInformation", "declared_type": "IlInformation", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_INTGRTN_35", "status": 400, "message": { "ar": "لا يمكن العثور على البيانات. رمز الخطأ: {0}", "en": "Data cannot be found. Error Code: {0}", "tr": "Veri bulunamadı. Hata Kodu: {0}" }, "message_available": true, "constant_name": "CREDIT_BUREAU_DATA_NOT_FOUND" }, { "code": "ERR_INTGRTN_36", "status": 400, "message": { "ar": "حقل {0} مطلوب.", "en": "{0} field is required.", "tr": "{0} alanı gereklidir." }, "message_available": true, "constant_name": "CREDIT_BUREAU_DATA_MANDATORY_FIELD" }, { "code": "ERR_INTGRTN_82", "status": 400, "message": null, "message_available": false, "constant_name": "NOT_CREATE_RISK_REPORT_FOR_CUSTOMER" } ] } } }, "/credit-bureau-infos/report-list/by-citizenid/{citizenId}": { "get": { "operationId": "aurax-bff-redirect-get-individual-report-list", "tags": [ "credit-bureau-infos" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "Get Individual Report List Bff Redirect", "description": "Invokes the `aurax-bff-redirect-get-individual-report-list` service definition through `GET /credit-bureau-infos/report-list/by-citizenid/{citizenId}`.\n\nTurkish display name: KKB Rapor Sonuçları Listeleme Bff\n\nRequest and response fields are declared on the routing target `get-individual-report-list`; this entry declares none of its own.", "parameters": [ { "name": "citizenId", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a collection.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-individual-report-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "credit-bureau-infos/report-list/by-citizenid/{citizenId}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-individual-report-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CitizenId", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "GetIndividualQueryInternalDto", "collection": true, "members": [ { "name": "ExternalServiceResultId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "RequestTime", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "IsLastQuery", "declared_type": "bool?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/currencies": { "get": { "operationId": "aurax-bff-redirect-get-currency-list", "tags": [ "currencies" ], "summary": "aurax-bff-redirect-get-currency-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-currency-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "currencies", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "CurrencyDto", "collection": true, "members": [ { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SubUnitName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Numeric", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Group", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CurrencyDecimal", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Translations", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-currency-list", "target_dapr_app_id": "core-service", "target_route": "currencies", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/customer-application-evaluate": { "post": { "operationId": "aurax-bff-redirect-customer-application-evaluate-ui-bpm", "tags": [ "customer-application-evaluate" ], "summary": "aurax-bff-redirect-customer-application-evaluate-ui-bpm", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-customer-application-evaluate-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-application-evaluate", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/customer-application-limit-assign": { "post": { "operationId": "customer-application-limit-assign", "tags": [ "customer-application-limit-assign" ], "summary": "customer-application-limit-assign", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "allotmentAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "allotmentAmount" }, "allotmentCurrencyNumber": { "type": "string", "x-aura-field-code": "allotmentCurrencyNumber" }, "allotmentProducts": { "type": "array", "items": { "type": "object", "properties": { "allotmentProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "allotmentProductId" }, "productAllotmentAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "productAllotmentAmount" }, "productValidityDay": { "type": "integer", "format": "int32", "x-aura-field-code": "productValidityDay" }, "validityDay": { "type": "integer", "format": "int32", "x-aura-field-code": "validityDay" } }, "required": [ "allotmentProductId", "productAllotmentAmount", "productValidityDay", "validityDay" ], "x-aura-field-code": "allotmentProducts" } }, "allotmentValidityDay": { "type": "integer", "format": "int32", "x-aura-field-code": "allotmentValidityDay" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "assets": { "type": "array", "items": { "type": "object", "properties": { "assetType": { "type": "integer", "format": "int32", "x-aura-field-code": "assetType" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "financialValue": { "type": "number", "format": "decimal", "x-aura-field-code": "financialValue" } }, "required": [ "assetType", "currencyNumber", "financialValue" ], "x-aura-field-code": "assets" } }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "details": { "type": "array", "items": { "type": "object", "properties": { "allotmentType": { "type": "integer", "format": "int32", "x-aura-field-code": "allotmentType" }, "allotmentTypeAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "allotmentTypeAmount" } }, "required": [ "allotmentType", "allotmentTypeAmount" ], "x-aura-field-code": "allotmentAssignmentDetails" } }, "dmsId": { "type": "string", "format": "uuid", "x-aura-field-code": "dmsId" }, "educationLevelOccupationTypeFieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "educationLevelOccupationTypeFieldId" }, "email": { "type": "string", "x-aura-field-code": "email" }, "expenses": { "type": "array", "items": { "type": "object", "properties": { "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "monthlyAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "monthlyAmount" }, "sourceOfExpense": { "type": "integer", "format": "int32", "x-aura-field-code": "sourceOfExpense" } }, "required": [ "currencyNumber", "monthlyAmount", "sourceOfExpense" ], "x-aura-field-code": "expenses" } }, "incomes": { "type": "array", "items": { "type": "object", "properties": { "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "monthlyAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "monthlyAmount" }, "sourceOfIncome": { "type": "integer", "format": "int32", "x-aura-field-code": "sourceOfIncome" } }, "required": [ "currencyNumber", "monthlyAmount", "sourceOfIncome" ], "x-aura-field-code": "incomes" } }, "isApprovalNeeded": { "type": "boolean", "x-aura-field-code": "isApprovalNeeded" }, "jobOccupationTypeFieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "jobOccupationTypeFieldId" }, "jobTitleOccupationTypeFieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "jobTitleOccupationTypeFieldId" }, "maritalStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "maritalStatus" }, "officePhoneNumber": { "type": "string", "x-aura-field-code": "officePhoneNumber" }, "payDay": { "type": "integer", "format": "int32", "x-aura-field-code": "payDay" }, "phoneNumber": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true }, "products": { "type": "array", "items": { "type": "string", "format": "uuid", "x-aura-field-code": "loanProductIds" } }, "validityDay": { "type": "integer", "format": "int32", "x-aura-field-code": "validityDay" }, "workingStyleOccupationTypeFieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "workingStyleOccupationTypeFieldId" }, "workplaceSign": { "type": "string", "x-aura-field-code": "workplaceSign" } }, "required": [ "allotmentAmount", "allotmentCurrencyNumber", "allotmentProducts", "allotmentValidityDay", "amount", "assets", "currencyNumber", "customerId", "details", "dmsId", "educationLevelOccupationTypeFieldId", "email", "expenses", "incomes", "isApprovalNeeded", "jobOccupationTypeFieldId", "jobTitleOccupationTypeFieldId", "maritalStatus", "officePhoneNumber", "payDay", "phoneNumber", "products", "validityDay", "workingStyleOccupationTypeFieldId", "workplaceSign" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 25, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "customer-application-limit-assign", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-application-limit-assign", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "PhoneNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "Email", "declared_type": null, "nullable": false, "collection": false }, { "name": "EducationLevelOccupationTypeFieldId", "declared_type": null, "nullable": false, "collection": false }, { "name": "JobOccupationTypeFieldId", "declared_type": null, "nullable": false, "collection": false }, { "name": "JobTitleOccupationTypeFieldId", "declared_type": null, "nullable": false, "collection": false }, { "name": "WorkingStyleOccupationTypeFieldId", "declared_type": null, "nullable": false, "collection": false }, { "name": "WorkplaceSign", "declared_type": null, "nullable": false, "collection": false }, { "name": "OfficePhoneNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "MaritalStatus", "declared_type": null, "nullable": false, "collection": false }, { "name": "Amount", "declared_type": null, "nullable": false, "collection": false }, { "name": "CurrencyNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "ValidityDay", "declared_type": null, "nullable": false, "collection": false }, { "name": "PayDay", "declared_type": null, "nullable": false, "collection": false }, { "name": "DmsId", "declared_type": null, "nullable": false, "collection": false }, { "name": "AllotmentValidityDay", "declared_type": null, "nullable": false, "collection": false }, { "name": "AllotmentAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "AllotmentCurrencyNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsApprovalNeeded", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" } } }, "/customer-application-reevaluate": { "post": { "operationId": "aurax-bff-redirect-reevaluate-customer-application-for-dgfin-bpmn", "tags": [ "customer-application-reevaluate" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-reevaluate-customer-application-for-dgfin-bpmn", "description": "Request and response fields are declared on the routing target `reevaluate-customer-application-for-dgfin-bpmn`; this entry declares none of its own.\n\nDeclared as Route-bound but absent from the route template, so not sendable: customerId.", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "customerApplicationId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerApplicationId" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "customerApplicationId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerApplicationId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "customerApplicationId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerApplicationId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-reevaluate-customer-application-for-dgfin-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-application-reevaluate", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/customer-application/update-status": { "post": { "operationId": "aurax-bff-redirect-update-customer-application-status-bpmn", "tags": [ "customer-application" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "Update Customer Application Status", "description": "Invokes the `aurax-bff-redirect-update-customer-application-status-bpmn` service definition through `POST /customer-application/update-status`.\n\nTurkish display name: Basvuru durumu Guncelleme\n\nRequest and response fields are declared on the routing target `update-customer-application-status-bpmn`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "applicationStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "applicationStatus" }, "customerApplicationId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerApplicationId" } }, "required": [ "applicationStatus", "customerApplicationId" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 2, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-customer-application-status-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-application/update-status", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/customer-applications": { "get": { "operationId": "aurax-bff-redirect-get-customer-application-list", "tags": [ "customer-applications" ], "summary": "aurax-bff-redirect-get-customer-application-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-customer-application-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-applications", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "CustomerApplicationDto", "collection": true, "members": [ { "name": "ApplicationNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ApplicationDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "ValidityDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "Amount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MaritalStatus", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Status", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "PhoneNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Email", "declared_type": "string", "nullable": false, "collection": false }, { "name": "EducationLevelOccupationTypeFieldId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "JobOccupationTypeFieldId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ApplicationScore", "declared_type": "string", "nullable": false, "collection": false }, { "name": "JobTitleOccupationTypeFieldId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "WorkingStyleOccupationTypeFieldId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "PayDay", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "WorkplaceSign", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OfficePhoneNumber", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-customer-application-list", "target_dapr_app_id": "customer-application-service", "target_route": "customer-applications", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-customer-application-ui-bpmn", "tags": [ "customer-applications" ], "summary": "aurax-bff-redirect-create-customer-application-ui-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-customer-application-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-applications", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "Amount", "declared_type": null, "nullable": true, "collection": false }, { "name": "CurrencyNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "MaritalStatus", "declared_type": null, "nullable": true, "collection": false }, { "name": "ValidityDay", "declared_type": null, "nullable": true, "collection": false }, { "name": "PhoneNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "Email", "declared_type": null, "nullable": false, "collection": false }, { "name": "EducationLevelOccupationTypeFieldId", "declared_type": null, "nullable": true, "collection": false }, { "name": "JobOccupationTypeFieldId", "declared_type": null, "nullable": true, "collection": false }, { "name": "JobTitleOccupationTypeFieldId", "declared_type": null, "nullable": true, "collection": false }, { "name": "WorkingStyleOccupationTypeFieldId", "declared_type": null, "nullable": true, "collection": false }, { "name": "PayDay", "declared_type": null, "nullable": true, "collection": false }, { "name": "WorkplaceSign", "declared_type": null, "nullable": false, "collection": false }, { "name": "OfficePhoneNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "PartnerId", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/customer-applications/{id}": { "get": { "operationId": "aurax-bff-redirect-get-customer-application-details-by-id", "tags": [ "customer-applications" ], "summary": "aurax-bff-redirect-get-customer-application-details-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-customer-application-details-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-applications/{id}", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "CustomerApplicationDetailsDto", "payload": "CustomerApplicationDetailsDto", "collection": false, "members": [ { "name": "ApplicationIncomes", "declared_type": "List", "nullable": false, "collection": true }, { "name": "ApplicationAssets", "declared_type": "List", "nullable": false, "collection": true }, { "name": "ApplicationExpenses", "declared_type": "List", "nullable": false, "collection": true }, { "name": "ApplicationProducts", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-customer-application-details-by-id", "target_dapr_app_id": "customer-application-service", "target_route": "customer-applications/{id}/details", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LAPPLCTN_1", "status": 400, "message": { "ar": "لم يتم العثور على تطبيق العميل. المعرف: {0}", "en": "Customer application cannot be found. :{0}" }, "message_available": true, "constant_name": "CUSTOMER_APPLICATION_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-customer-application-ui-bpmn", "tags": [ "customer-applications" ], "summary": "aurax-bff-redirect-update-customer-application-ui-bpmn", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-customer-application-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-applications/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "ValidityDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "Amount", "declared_type": null, "nullable": true, "collection": false }, { "name": "CurrencyNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "MaritalStatus", "declared_type": null, "nullable": true, "collection": false }, { "name": "PhoneNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "Email", "declared_type": null, "nullable": false, "collection": false }, { "name": "EducationLevelOccupationTypeFieldId", "declared_type": null, "nullable": true, "collection": false }, { "name": "JobOccupationTypeFieldId", "declared_type": null, "nullable": true, "collection": false }, { "name": "JobTitleOccupationTypeFieldId", "declared_type": null, "nullable": true, "collection": false }, { "name": "WorkingStyleOccupationTypeFieldId", "declared_type": null, "nullable": true, "collection": false }, { "name": "PayDay", "declared_type": null, "nullable": true, "collection": false }, { "name": "WorkplaceSign", "declared_type": null, "nullable": false, "collection": false }, { "name": "OfficePhoneNumber", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/customer-blockeds": { "get": { "operationId": "aurax-bff-dynamic-get-blocked-customer-list", "tags": [ "customer-blockeds" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-blocked-customer-list", "description": "Request and response fields are declared on the routing target `get-blocked-customer-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "accountBlockeds": { "type": "array", "items": { "type": "object", "properties": { "accountBlockedId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountBlockedId" }, "accountId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountId" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "accountBlockedAmount" }, "amountBlockedCurrency": { "type": "number", "format": "decimal", "x-aura-field-code": "accountBlockeds_amountBlockedCurrency" }, "exchangeRate": { "type": "number", "format": "decimal", "x-aura-field-code": "exchangeRate" } }, "x-aura-field-code": "accountBlockeds" } }, "blockedAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "blockedAmount" }, "blockedCurrencyNumber": { "type": "string", "x-aura-field-code": "blockedCurrencyNumber" }, "blockedDate": { "type": "string", "format": "date", "x-aura-field-code": "blockedDate" }, "blockedDueDate": { "type": "string", "format": "date", "x-aura-field-code": "blockedDueDate" }, "blockedItemId": { "type": "string", "format": "uuid", "x-aura-field-code": "blockedItemId" }, "blockedSubType": { "type": "integer", "format": "int32", "x-aura-field-code": "blockedSubType" }, "blockedType": { "type": "integer", "format": "int32", "x-aura-field-code": "blockedType" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "description": { "type": "string", "x-aura-field-code": "description" }, "direction": { "type": "string", "x-aura-field-code": "direction" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "unblockedDate": { "type": "string", "format": "date-time", "x-aura-field-code": "unblockedDate" }, "unblockedReason": { "type": "string", "x-aura-field-code": "unblockedReason" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-blocked-customer-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-blockeds", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-blocked-customer-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "CustomerBlockedDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "BlockedItemId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "BlockedAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "BlockedCurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BlockedType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "BlockedDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "BlockedDueDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "UnblockedDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "UnblockedReason", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "Direction", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AccountBlockeds", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-blocked-customer-list", "target_dapr_app_id": "account-service", "target_route": "customer-blockeds", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-dynamic-create-customer-blocked-ui-bpmn", "tags": [ "customer-blockeds" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-create-customer-blocked-ui-bpmn", "description": "Request and response fields are declared on the routing target `create-customer-blocked-ui-bpmn`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "blockedAccounts": { "type": "array", "items": { "type": "object", "properties": { "accountId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountId" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "accountBlockedAmount" }, "available": { "type": "number", "format": "decimal", "x-aura-field-code": "available" }, "blockedSubType": { "type": "integer", "format": "int32", "x-aura-field-code": "blockedSubType" } }, "x-aura-field-code": "blockedAccounts" } }, "blockedCurrencyNumber": { "type": "string", "x-aura-field-code": "blockedCurrencyNumber" }, "blockedDueDate": { "type": "string", "format": "date", "x-aura-field-code": "blockedDueDate" }, "blockedItemId": { "type": "string", "format": "uuid", "x-aura-field-code": "blockedItemId" }, "blockedType": { "type": "integer", "format": "int32", "x-aura-field-code": "blockedType" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "description": { "type": "string", "x-aura-field-code": "description" }, "direction": { "type": "string", "x-aura-field-code": "direction" } }, "required": [ "blockedItemId", "blockedType", "customerId", "description" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 8, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-create-customer-blocked-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-blockeds", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/customer-blockeds/{id}": { "get": { "operationId": "aurax-bff-dynamic-get-blocked-customer-by-id", "tags": [ "customer-blockeds" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-blocked-customer-by-id", "description": "Request and response fields are declared on the routing target `get-blocked-customer-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "customerBlockedId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "accountBlockeds": { "type": "array", "items": { "type": "object", "properties": { "accountBlockedId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountBlockedId" }, "accountId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountId" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "amountBlockedCurrency": { "x-aura-type": "unresolved" }, "blockedSubType": { "type": "integer", "format": "int32", "x-aura-field-code": "blockedSubType" }, "exchangeRate": { "type": "number", "format": "decimal", "x-aura-field-code": "exchangeRate" } }, "x-aura-field-code": "accountBlockeds" } }, "blockedAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "blockedAmount" }, "blockedCurrencyNumber": { "type": "string", "x-aura-field-code": "blockedCurrencyNumber" }, "blockedDate": { "type": "string", "format": "date", "x-aura-field-code": "blockedDate" }, "blockedDueDate": { "type": "string", "format": "date", "x-aura-field-code": "blockedDueDate" }, "blockedItemId": { "type": "string", "format": "uuid", "x-aura-field-code": "blockedItemId" }, "blockedType": { "type": "integer", "format": "int32", "x-aura-field-code": "blockedType" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "description": { "x-aura-type": "unresolved" }, "direction": { "x-aura-type": "unresolved" }, "id": { "x-aura-type": "unresolved" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "unblockedDate": { "x-aura-type": "unresolved" }, "unblockedReason": { "type": "string", "x-aura-field-code": "unblockedReason" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-blocked-customer-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-blockeds/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "CustomerBlockedDto", "payload": "CustomerBlockedDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "BlockedItemId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "BlockedAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "BlockedCurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BlockedType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "BlockedDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "BlockedDueDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "UnblockedDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "UnblockedReason", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "Direction", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AccountBlockeds", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-blocked-customer-by-id", "target_dapr_app_id": "account-service", "target_route": "customer-blockeds/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCNT_128", "status": 400, "message": { "ar": "العميل المحظور غير موجود.", "en": "Customer blocked not found.", "tr": "Müşteri bloke edildi bulunamadı." }, "message_available": true, "constant_name": "CUSTOMER_BLOCKED_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-dynamic-edit-customer-blocked-ui-bpmn", "tags": [ "customer-blockeds" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-edit-customer-blocked-ui-bpmn", "description": "Request and response fields are declared on the routing target `edit-customer-blocked-ui-bpmn`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "accountBlockeds": { "type": "array", "items": { "type": "object", "properties": { "accountBlockedId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountBlockedId" }, "accountId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountId" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "accountBlockedAmount" }, "available": { "type": "number", "format": "decimal", "x-aura-field-code": "available" }, "blockedSubType": { "type": "integer", "format": "int32", "x-aura-field-code": "blockedSubType" }, "unBlockAccount": { "type": "boolean", "x-aura-field-code": "unBlockAccount" }, "unBlockamount": { "type": "number", "format": "decimal", "x-aura-field-code": "unBlockamount" } }, "required": [ "accountBlockedId" ], "x-aura-field-code": "accountBlockeds" } }, "blockedAccounts": { "type": "array", "items": { "type": "object", "x-aura-field-code": "blockedAccounts" } }, "blockedCurrencyNumber": { "type": "string", "x-aura-field-code": "blockedCurrencyNumber" }, "blockedDueDate": { "type": "string", "format": "date", "x-aura-field-code": "blockedDueDate" }, "blockedItemId": { "type": "string", "format": "uuid", "x-aura-field-code": "blockedItemId" }, "blockedType": { "type": "integer", "format": "int32", "x-aura-field-code": "blockedType" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "description": { "type": "string", "x-aura-field-code": "description" }, "direction": { "type": "string", "x-aura-field-code": "direction" }, "unblockedReason": { "type": "string", "x-aura-field-code": "unblockedReason" } }, "required": [ "blockedType", "description", "unblockedReason" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 10, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-edit-customer-blocked-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-blockeds/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/customer-groups": { "get": { "operationId": "aurax-bff-get-customer-group-list", "tags": [ "customer-groups" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-get-customer-group-list", "description": "Request and response fields are declared on the routing target `get-customer-group-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "customerGroupCode" }, "customerGroupMembers": { "type": "array", "items": { "type": "object", "properties": { "customerGroupId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerGroupId" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "firmType": { "type": "integer", "format": "int32", "x-aura-field-code": "firmType" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerGroupMemberId" } }, "x-aura-field-code": "customerGroupMembers" } }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerGroupId" }, "name": { "type": "string", "x-aura-field-code": "customerGroupName" }, "type": { "type": "integer", "format": "int32", "x-aura-field-code": "customerGroupType" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-get-customer-group-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-groups", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-customer-group-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "post": { "operationId": "aurax-bff-create-customer-group-ui-bpmn", "tags": [ "customer-groups" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "create-customer-group-ui-bpmn", "description": "Invokes the `aurax-bff-create-customer-group-ui-bpmn` service definition through `POST /customer-groups`.\n\nRequest and response fields are declared on the routing target `create-customer-group-ui-bpmn`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "customerGroupMembers": { "type": "array", "items": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "firmType": { "type": "integer", "format": "int32", "x-aura-field-code": "firmType" } }, "required": [ "customerId", "firmType" ], "x-aura-field-code": "customerGroupMembers" } }, "name": { "type": "string", "x-aura-field-code": "customerGroupName" }, "type": { "type": "integer", "format": "int32", "x-aura-field-code": "customerGroupType" } }, "required": [ "customerGroupMembers", "name", "type" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 3, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "customerGroupId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerGroupId" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "customerGroupId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerGroupId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "customerGroupId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerGroupId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-create-customer-group-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-groups", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/customer-groups/by-customer/{customerId}": { "get": { "operationId": "aurax-bff-redirect-get-customer-groups-by-customer-id", "tags": [ "customer-groups" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-customer-groups-by-customer-id", "description": "Request and response fields are declared on the routing target `get-customer-groups-by-customer-id`; this entry declares none of its own.", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" } }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "customerGroupCode" }, "customerGroupMembers": { "type": "array", "items": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "firmType": { "type": "integer", "format": "int32", "x-aura-field-code": "firmType" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerGroupMemberId" } }, "x-aura-field-code": "customerGroupMembers" } }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerGroupId" }, "name": { "type": "string", "x-aura-field-code": "customerGroupName" }, "type": { "type": "integer", "format": "int32", "x-aura-field-code": "customerGroupType" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-customer-groups-by-customer-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-groups/by-customer/{customerId}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/customer-groups/{id}": { "delete": { "operationId": "aurax-bff-delete-customer-group-ui-bpmn", "tags": [ "customer-groups" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-delete-customer-group-ui-bpmn", "description": "Request and response fields are declared on the routing target `delete-customer-group-ui-bpmn`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "customerGroupId" } } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-delete-customer-group-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-groups/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "get": { "operationId": "aurax-bff-get-customer-group-by-id", "tags": [ "customer-groups" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-get-customer-group-by-id", "description": "Request and response fields are declared on the routing target `get-customer-group-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "customerGroupId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "customerGroupCode" }, "customerGroupMembers": { "type": "array", "items": { "type": "object", "properties": { "customerGroupId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerGroupId" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "firmType": { "type": "integer", "format": "int32", "x-aura-field-code": "firmType" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerGroupMemberId" } }, "x-aura-field-code": "customerGroupMembers" } }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerGroupId" }, "name": { "type": "string", "x-aura-field-code": "customerGroupName" }, "type": { "type": "integer", "format": "int32", "x-aura-field-code": "customerGroupType" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-get-customer-group-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-groups/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "put": { "operationId": "aurax-bff-update-customer-group-ui-bpmn", "tags": [ "customer-groups" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "update-customer-group-ui-bpmn", "description": "Invokes the `aurax-bff-update-customer-group-ui-bpmn` service definition through `PUT /customer-groups/{id}`.\n\nRequest and response fields are declared on the routing target `update-customer-group-ui-bpmn`; this entry declares none of its own.\n\nDeclared as Route-bound but absent from the route template, so not sendable: code.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in this route template but not among the Route-bound fields of the routing target `update-customer-group-ui-bpmn`, whose own path is decoupled from this one.", "x-aura-source": "route-template-only-after-collapse" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "customerGroupMembers": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "_rowStatus" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "firmType": { "type": "integer", "format": "int32", "x-aura-field-code": "firmType" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerGroupMemberId" } }, "required": [ "_rowStatus" ], "x-aura-field-code": "customerGroupMembers" } }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerGroupId" }, "name": { "type": "string", "x-aura-field-code": "customerGroupName" }, "type": { "type": "integer", "format": "int32", "x-aura-field-code": "customerGroupType" } }, "required": [ "customerGroupMembers", "id", "name", "type" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 4, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-update-customer-group-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-groups/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/customer-limit-assign": { "post": { "operationId": "customer-limit-assign", "tags": [ "customer-limit-assign" ], "summary": "customer-limit-assign", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "allotmentAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "allotmentAmount" }, "allotmentCurrencyNumber": { "type": "string", "x-aura-field-code": "allotmentCurrencyNumber" }, "allotmentProducts": { "type": "array", "items": { "type": "object", "properties": { "allotmentProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "allotmentProductId" }, "productAllotmentAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "productAllotmentAmount" }, "productValidityDay": { "type": "integer", "format": "int32", "x-aura-field-code": "productValidityDay" }, "validityDay": { "type": "integer", "format": "int32", "x-aura-field-code": "validityDay" } }, "required": [ "allotmentProductId", "productAllotmentAmount", "productValidityDay", "validityDay" ], "x-aura-field-code": "allotmentProducts" } }, "allotmentValidityDay": { "type": "integer", "format": "int32", "x-aura-field-code": "allotmentValidityDay" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "assets": { "type": "array", "items": { "type": "object", "properties": { "assetType": { "type": "integer", "format": "int32", "x-aura-field-code": "assetType" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "financialValue": { "type": "number", "format": "decimal", "x-aura-field-code": "financialValue" } }, "required": [ "assetType", "currencyNumber", "financialValue" ], "x-aura-field-code": "assets" } }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "details": { "type": "array", "items": { "type": "object", "properties": { "allotmentType": { "type": "integer", "format": "int32", "x-aura-field-code": "allotmentType" }, "allotmentTypeAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "allotmentTypeAmount" } }, "required": [ "allotmentType", "allotmentTypeAmount" ], "x-aura-field-code": "allotmentAssignmentDetails" } }, "dmsId": { "type": "string", "format": "uuid", "x-aura-field-code": "dmsId" }, "educationLevelOccupationTypeFieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "educationLevelOccupationTypeFieldId" }, "email": { "type": "string", "x-aura-field-code": "email" }, "expenses": { "type": "array", "items": { "type": "object", "properties": { "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "monthlyAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "monthlyAmount" }, "sourceOfExpense": { "type": "integer", "format": "int32", "x-aura-field-code": "sourceOfExpense" } }, "required": [ "currencyNumber", "monthlyAmount", "sourceOfExpense" ], "x-aura-field-code": "expenses" } }, "incomes": { "type": "array", "items": { "type": "object", "properties": { "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "monthlyAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "monthlyAmount" }, "sourceOfIncome": { "type": "integer", "format": "int32", "x-aura-field-code": "sourceOfIncome" } }, "required": [ "currencyNumber", "monthlyAmount", "sourceOfIncome" ], "x-aura-field-code": "incomes" } }, "isApprovalNeeded": { "type": "boolean", "x-aura-field-code": "isApprovalNeeded" }, "jobOccupationTypeFieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "jobOccupationTypeFieldId" }, "jobTitleOccupationTypeFieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "jobTitleOccupationTypeFieldId" }, "maritalStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "maritalStatus" }, "officePhoneNumber": { "type": "string", "x-aura-field-code": "officePhoneNumber" }, "payDay": { "type": "integer", "format": "int32", "x-aura-field-code": "payDay" }, "phoneNumber": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true }, "products": { "type": "array", "items": { "type": "string", "format": "uuid", "x-aura-field-code": "loanProductIds" } }, "validityDay": { "type": "integer", "format": "int32", "x-aura-field-code": "validityDay" }, "workingStyleOccupationTypeFieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "workingStyleOccupationTypeFieldId" }, "workplaceSign": { "type": "string", "x-aura-field-code": "workplaceSign" } }, "required": [ "allotmentAmount", "allotmentCurrencyNumber", "allotmentProducts", "allotmentValidityDay", "amount", "assets", "currencyNumber", "customerId", "details", "dmsId", "educationLevelOccupationTypeFieldId", "email", "expenses", "incomes", "isApprovalNeeded", "jobOccupationTypeFieldId", "jobTitleOccupationTypeFieldId", "maritalStatus", "officePhoneNumber", "payDay", "phoneNumber", "products", "validityDay", "workingStyleOccupationTypeFieldId", "workplaceSign" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 25, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "customer-limit-assign", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-limit-assign", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "PhoneNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "Email", "declared_type": null, "nullable": false, "collection": false }, { "name": "EducationLevelOccupationTypeFieldId", "declared_type": null, "nullable": false, "collection": false }, { "name": "JobOccupationTypeFieldId", "declared_type": null, "nullable": false, "collection": false }, { "name": "JobTitleOccupationTypeFieldId", "declared_type": null, "nullable": false, "collection": false }, { "name": "WorkingStyleOccupationTypeFieldId", "declared_type": null, "nullable": false, "collection": false }, { "name": "WorkplaceSign", "declared_type": null, "nullable": false, "collection": false }, { "name": "OfficePhoneNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "MaritalStatus", "declared_type": null, "nullable": false, "collection": false }, { "name": "Amount", "declared_type": null, "nullable": false, "collection": false }, { "name": "CurrencyNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "ValidityDay", "declared_type": null, "nullable": false, "collection": false }, { "name": "PayDay", "declared_type": null, "nullable": false, "collection": false }, { "name": "DmsId", "declared_type": null, "nullable": false, "collection": false }, { "name": "AllotmentValidityDay", "declared_type": null, "nullable": false, "collection": false }, { "name": "AllotmentAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "AllotmentCurrencyNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsApprovalNeeded", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "documentation": { "summary": "Mutasyon yapan her dahili servis cagrisindan once yeni bir correlationId ve buna karsilik gelen yetki imzasi header'lari atar (mevcut handler deseni).", "source": "the service's own XML documentation comment, read from its source", "about": "the handler that serves this route" } } } }, "/customer-loan-application-evaluate-ui-bpm": { "post": { "operationId": "aurax-bff-service-dynamic-customer-loan-application-evaluate-ui-bpm", "tags": [ "customer-loan-application-evaluate-ui-bpm" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-customer-loan-application-evaluate-ui-bpm", "description": "Request and response fields are declared on the routing target `customer-loan-application-evaluate-ui-bpm`; this entry declares none of its own.\n\nDeclared as Route-bound but absent from the route template, so not sendable: dmsId.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "accountId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountId" }, "accountNumber": { "type": "string", "x-aura-field-code": "accountNumber" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "applicationAmount" }, "assets": { "type": "array", "items": { "type": "object", "properties": { "assetType": { "type": "integer", "format": "int32", "x-aura-field-code": "assetType" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "financialValue": { "type": "number", "format": "decimal", "x-aura-field-code": "financialValue" } }, "required": [ "assetType", "currencyNumber" ], "x-aura-field-code": "assets" } }, "basePriceId": { "type": "string", "format": "uuid", "x-aura-field-code": "basePriceId" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "educationLevelOccupationTypeFieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "educationLevelOccupationTypeFieldId" }, "email": { "type": "string", "x-aura-field-code": "email" }, "expenses": { "type": "array", "items": { "type": "object", "properties": { "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "monthlyAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "monthlyAmount" }, "sourceOfExpense": { "type": "integer", "format": "int32", "x-aura-field-code": "sourceOfExpense" } }, "required": [ "currencyNumber", "monthlyAmount", "sourceOfExpense" ], "x-aura-field-code": "expenses" } }, "firstInstallmentDate": { "type": "string", "format": "date-time", "x-aura-field-code": "firstInstallmentDate" }, "fixedRate": { "type": "number", "format": "decimal", "x-aura-field-code": "fixedRate" }, "incomes": { "type": "array", "items": { "type": "object", "properties": { "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "monthlyAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "monthlyAmount" }, "sourceOfIncome": { "type": "integer", "format": "int32", "x-aura-field-code": "sourceOfIncome" } }, "required": [ "currencyNumber", "monthlyAmount", "sourceOfIncome" ], "x-aura-field-code": "incomes" } }, "installmentCount": { "type": "integer", "format": "int32", "x-aura-field-code": "installmentCount" }, "installments": { "type": "array", "items": { "type": "object", "properties": { "balloonPaymentAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "balloonPaymentAmount" }, "installmentAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "installmentAmount" }, "installmentDate": { "type": "string", "format": "date-time", "x-aura-field-code": "installmentDate" }, "installmentSequenceNo": { "type": "integer", "format": "int32", "x-aura-field-code": "installmentSequenceNo" } }, "required": [ "installmentDate" ], "x-aura-field-code": "installments" } }, "isFixed": { "type": "boolean", "x-aura-field-code": "isFixed" }, "isInclude": { "type": "boolean", "x-aura-field-code": "isInclude" }, "jobOccupationTypeFieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "jobOccupationTypeFieldId" }, "jobTitleOccupationTypeFieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "jobTitleOccupationTypeFieldId" }, "maritalStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "maritalStatus" }, "metalCode": { "type": "string", "x-aura-field-code": "metalCode" }, "officePhoneNumber": { "type": "string", "x-aura-field-code": "officePhoneNumber" }, "payDay": { "type": "integer", "format": "int32", "x-aura-field-code": "payDay" }, "paybackPlanMethod": { "type": "integer", "format": "int32", "x-aura-field-code": "paybackPlanMethod" }, "phoneNumber": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true }, "productAmount": { "type": "number", "x-aura-field-code": "productAmount" }, "products": { "type": "array", "items": { "type": "string", "format": "uuid", "x-aura-field-code": "loanProductIds" } }, "showCommodityCard": { "type": "boolean", "x-aura-field-code": "showCommodityCard" }, "unitPrice": { "type": "number", "format": "decimal", "x-aura-field-code": "unitPrice" }, "uploadId": { "type": "string", "format": "uuid", "x-aura-field-code": "uploadId" }, "validityDay": { "type": "integer", "format": "int32", "x-aura-field-code": "validityDay" }, "weight": { "type": "number", "x-aura-field-code": "weight" }, "workingStyleOccupationTypeFieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "workingStyleOccupationTypeFieldId" }, "workplaceSign": { "type": "string", "x-aura-field-code": "workplaceSign" } }, "required": [ "amount", "customerId", "firstInstallmentDate", "installmentCount", "isInclude", "jobOccupationTypeFieldId", "jobTitleOccupationTypeFieldId", "paybackPlanMethod", "productAmount", "products" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 34, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-customer-loan-application-evaluate-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-loan-application-evaluate-ui-bpm", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/customer-loan-campaigns": { "get": { "operationId": "aurax-bff-redirect-get-customer-loan-campaign-list", "tags": [ "customer-loan-campaigns" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-customer-loan-campaign-list", "description": "Request and response fields are declared on the routing target `get-customer-loan-campaign-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a collection.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-customer-loan-campaign-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-loan-campaigns", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-customer-loan-campaign-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "CustomerLoanCampaignDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "LoanCampaignId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "LoanId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "BenefitDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "Amount", "declared_type": "decimal", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/customer-loan-collections": { "get": { "operationId": "aurax-bff-redirect-customer-loan-collections-ui-list", "tags": [ "customer-loan-collections" ], "summary": "aurax-bff-redirect-customer-loan-collections-ui-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-customer-loan-collections-ui-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-loan-collections", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "post": { "operationId": "aurax-bff-redirect-create-customer-loan-collection-ui-bpmn", "tags": [ "customer-loan-collections" ], "summary": "aurax-bff-redirect-create-customer-loan-collection-ui-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-customer-loan-collection-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-loan-collections", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "LoanCollectionId", "declared_type": null, "nullable": false, "collection": false }, { "name": "InstallmentId", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountId", "declared_type": null, "nullable": false, "collection": false }, { "name": "CollectionType", "declared_type": null, "nullable": false, "collection": false }, { "name": "CollectionResource", "declared_type": null, "nullable": false, "collection": false }, { "name": "InstallmentType", "declared_type": null, "nullable": false, "collection": false }, { "name": "InstallmentTotalAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "CollectionAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "DiscountAmount", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/customer-loan-collections/by-installment-id/{installmentId}/details": { "get": { "operationId": "aurax-bff-redirect-get-customer-loan-collection-details-by-installment-id", "tags": [ "customer-loan-collections" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-customer-loan-collection-details-by-installment-id", "description": "Request and response fields are declared on the routing target `get-customer-loan-collection-details-by-installment-id`; this entry declares none of its own.", "parameters": [ { "name": "installmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "installmentId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "accountId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountId" }, "accountingEntryId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryId" }, "cancelDate": { "type": "string", "format": "date-time", "x-aura-field-code": "cancelDate" }, "cancelDescription": { "type": "string", "x-aura-field-code": "cancelDescription" }, "cancelType": { "type": "integer", "format": "int32", "x-aura-field-code": "cancelType" }, "collectionAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "collectionAmount" }, "collectionDate": { "type": "string", "format": "date-time", "x-aura-field-code": "collectionDate" }, "collectionDetails": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "collectionDetailType": { "type": "integer", "format": "int32", "x-aura-field-code": "collectionDetailType" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerLoanCollectionDetailId" } }, "x-aura-field-code": "collectionDetails" } }, "collectionResource": { "type": "integer", "format": "int32", "x-aura-field-code": "collectionResource" }, "collectionStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "collectionStatus" }, "collectionType": { "type": "integer", "format": "int32", "x-aura-field-code": "collectionType" }, "delayPenalties": { "type": "array", "items": { "type": "object", "properties": { "accountingEntryId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryId" }, "calculatedMethod": { "type": "integer", "format": "int32", "x-aura-field-code": "calculatedMethod" }, "delayAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "delayAmount" }, "delayDayCount": { "type": "integer", "format": "int32", "x-aura-field-code": "delayDayCount" }, "fromAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "fromAmount" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "delayPenaltyId" }, "rate": { "type": "number", "format": "decimal", "x-aura-field-code": "rate" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "status" }, "taxes": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "delayPenaltyTaxId" }, "taxId": { "type": "string", "format": "uuid", "x-aura-field-code": "taxId" } }, "x-aura-field-code": "taxes" } }, "totalDelayAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "totalDelayAmount" } }, "x-aura-field-code": "delayPenalties" } }, "discountAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "discountAmount" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerLoanCollectionId" }, "installmentId": { "type": "string", "format": "uuid", "x-aura-field-code": "installmentId" }, "installmentTotalAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "installmentTotalAmount" }, "installmentType": { "type": "integer", "format": "int32", "x-aura-field-code": "installmentType" }, "loanCollectionId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanCollectionId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-customer-loan-collection-details-by-installment-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-loan-collections/by-installment-id/{installmentId}/details", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "InstallmentId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "CustomerLoanCollectionDetailsDto", "collection": true, "members": [ { "name": "DelayPenalties", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." } } }, "/customer-loan-collections/calculate-early-repayment": { "post": { "operationId": "aurax-bff-redirect-calculate-early-repayment-bpmn", "tags": [ "customer-loan-collections" ], "summary": "aurax-bff-redirect-calculate-early-repayment-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-calculate-early-repayment-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-loan-collections/calculate-early-repayment", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/customer-loan-collections/cancel": { "post": { "operationId": "aurax-bff-redirect-cancel-customer-loan-collection-installment-ui-bpmn", "tags": [ "customer-loan-collections" ], "summary": "aurax-bff-redirect-cancel-customer-loan-collection-installment-ui-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-cancel-customer-loan-collection-installment-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-loan-collections/cancel", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/customer-loan-collections/create-early-repayment": { "post": { "operationId": "aurax-bff-redirect-create-early-repayment-bpmn", "tags": [ "customer-loan-collections" ], "summary": "aurax-bff-redirect-create-early-repayment-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-early-repayment-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-loan-collections/create-early-repayment", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/customer-loan-collections/{customerId}/finalized-debt-accounts": { "get": { "operationId": "aurax-bff-redirect-get-customer-loan-finalized-debt-accounts-ui-list", "tags": [ "customer-loan-collections" ], "summary": "aurax-bff-redirect-get-customer-loan-finalized-debt-accounts-ui-list", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-customer-loan-finalized-debt-accounts-ui-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-loan-collections/{customerId}/finalized-debt-accounts", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/customer-loan-collections/{id}/all-details": { "get": { "operationId": "aurax-bff-redirect-get-customer-loan-collection-detail-query", "tags": [ "customer-loan-collections" ], "summary": "aurax-bff-redirect-get-customer-loan-collection-detail-query", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-customer-loan-collection-detail-query", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-loan-collections/{id}/all-details", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/customer-loan-collections/{id}/details": { "get": { "operationId": "aurax-bff-redirect-get-customer-loan-collection-details-by-id", "tags": [ "customer-loan-collections" ], "summary": "aurax-bff-redirect-get-customer-loan-collection-details-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-customer-loan-collection-details-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-loan-collections/{id}/details", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "CustomerLoanCollectionDetailsDto", "payload": "CustomerLoanCollectionDetailsDto", "collection": false, "members": [ { "name": "DelayPenalties", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-customer-loan-collection-details-by-id", "target_dapr_app_id": "loan-collection-service", "target_route": "customer-loan-collections/{id}/details", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_COLLECTION_18", "status": 400, "message": { "ar": "لا يمكن العثور على جمع قرض العميل. :{0}", "en": "Customer loan collection cannot be found. :{0}", "tr": "Müşteri kredisi tahsilatı bulunamadı. : {0}" }, "message_available": true, "constant_name": "CUSTOMER_LOAN_COLLECTION_MUST_BE_NOT_NULL" } ] } } }, "/customer-loan-collections/{id}/installment-delay-penalties/{installmentDelayPenaltyId}": { "get": { "operationId": "aurax-bff-redirect-get-installment-delay-penalty-by-id", "tags": [ "customer-loan-collections" ], "summary": "aurax-bff-redirect-get-installment-delay-penalty-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "installmentDelayPenaltyId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-installment-delay-penalty-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-loan-collections/{id}/installment-delay-penalties/{installmentDelayPenaltyId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "InstallmentDelayPenaltyId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "InstallmentDelayPenaltyDto", "payload": "InstallmentDelayPenaltyDto", "collection": false, "members": [ { "name": "AccountingEntryId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "DelayAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "TotalDelayAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "FromAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "Status", "declared_type": "int", "nullable": false, "collection": false }, { "name": "DelayDayCount", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Rate", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CalculatedMethod", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Taxes", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-installment-delay-penalty-by-id", "target_dapr_app_id": "loan-collection-service", "target_route": "customer-loan-collections/{id}/installment-delay-penalties/{installmentDelayPenaltyId}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_COLLECTION_18", "status": 400, "message": { "ar": "لا يمكن العثور على جمع قرض العميل. :{0}", "en": "Customer loan collection cannot be found. :{0}", "tr": "Müşteri kredisi tahsilatı bulunamadı. : {0}" }, "message_available": true, "constant_name": "CUSTOMER_LOAN_COLLECTION_MUST_BE_NOT_NULL" }, { "code": "ERR_COLLECTION_22", "status": 400, "message": { "ar": "لا يمكن العثور على غرامة تأخير القسط. غرامة تأخير القسط: {0}", "en": "Installment delay penalty cannot be found. Installment Delay Penalty:{0}", "tr": "Taksit gecikme cezası bulunamadı. Taksit gecikme cezası:{0}" }, "message_available": true, "constant_name": "LOAN_COLLECTION_INSTALLMENT_DELAY_PENALTIES_NOT_FOUND" } ] } } }, "/customer-loan-collections/{id}/installment-delay-penalties/{installmentDelayPenaltyId}/status": { "put": { "operationId": "aurax-bff-redirect-update-installment-delay-penalty-status-ui-bpmn", "tags": [ "customer-loan-collections" ], "summary": "aurax-bff-redirect-update-installment-delay-penalty-status-ui-bpmn", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "installmentDelayPenaltyId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-installment-delay-penalty-status-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-loan-collections/{id}/installment-delay-penalties/{installmentDelayPenaltyId}/status", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "InstallmentDelayPenaltyId", "declared_type": null, "nullable": false, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/customer-loan-collections/{loanId}/delay-penalties": { "get": { "operationId": "aurax-bff-redirect-get-customer-loan-collections-delay-penalty-list", "tags": [ "customer-loan-collections" ], "summary": "aurax-bff-redirect-get-customer-loan-collections-delay-penalty-list", "parameters": [ { "name": "loanId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-customer-loan-collections-delay-penalty-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-loan-collections/{loanId}/delay-penalties", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/customer-loan-collections/{loanId}/installments": { "get": { "operationId": "aurax-bff-redirect-get-customer-loan-collection-installment-list-by-loan-id", "tags": [ "customer-loan-collections" ], "summary": "aurax-bff-redirect-get-customer-loan-collection-installment-list-by-loan-id", "parameters": [ { "name": "loanId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-customer-loan-collection-installment-list-by-loan-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-loan-collections/{loanId}/installments", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/customer-probability-defaults": { "get": { "operationId": "aurax-bff-redirect-get-probability-default-list", "tags": [ "customer-probability-defaults" ], "summary": "aurax-bff-redirect-get-probability-default-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-probability-default-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-probability-defaults", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "CustomerProbabilityDefaultDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CustomerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "BasedValue", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "ModelValue", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "ModelScore", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ModelSegment", "declared_type": "string", "nullable": false, "collection": false }, { "name": "QueryDateTime", "declared_type": "DateTime?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-probability-default-list", "target_dapr_app_id": "risk-management-service", "target_route": "customer-probability-defaults", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/customer-risk-levels": { "get": { "operationId": "aurax-bff-redirect-get-customer-risk-level-list", "tags": [ "customer-risk-levels" ], "summary": "aurax-bff-redirect-get-customer-risk-level-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-customer-risk-level-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-risk-levels", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "CustomerRiskLevelDto", "collection": true, "members": [ { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Level", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Score", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "Status", "declared_type": "int", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-customer-risk-level-list", "target_dapr_app_id": "risk-management-service", "target_route": "customer-risk-levels", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-customer-risk-level-bpmn", "tags": [ "customer-risk-levels" ], "summary": "aurax-bff-redirect-create-customer-risk-level-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-customer-risk-level-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-risk-levels", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "Level", "declared_type": null, "nullable": false, "collection": false }, { "name": "Score", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/customer-risk-levels/calculate": { "post": { "operationId": "aurax-bff-redirect-calculate-customer-risk-level-ui-bpmn", "tags": [ "customer-risk-levels" ], "summary": "aurax-bff-redirect-calculate-customer-risk-level-ui-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-calculate-customer-risk-level-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-risk-levels/calculate", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/customer-risk-levels/{id}/details": { "get": { "operationId": "aurax-bff-redirect-get-customer-risk-level-details-by-id", "tags": [ "customer-risk-levels" ], "summary": "aurax-bff-redirect-get-customer-risk-level-details-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-customer-risk-level-details-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-risk-levels/{id}/details", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "CustomerRiskLevelDetailDto", "payload": "CustomerRiskLevelDetailDto", "collection": false, "members": [ { "name": "Histories", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-customer-risk-level-details-by-id", "target_dapr_app_id": "risk-management-service", "target_route": "customer-risk-levels/{id}/details", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_RISKMNG_12", "status": 400, "message": { "ar": "لا يمكن العثور على مستوى خطر الشخص: {0}", "en": "Person risk level cannot be found. :{0}", "tr": "Kişi risk düzeyi bulunamadı. : {0}" }, "message_available": true, "constant_name": "CUSTOMER_RISK_LEVEL_NOT_FOUND" } ] } } }, "/customer-risk-levels/{id}/status": { "put": { "operationId": "aurax-bff-redirect-update-customer-risk-level-status-bpmn", "tags": [ "customer-risk-levels" ], "summary": "aurax-bff-redirect-update-customer-risk-level-status-bpmn", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-customer-risk-level-status-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-risk-levels/{id}/status", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/customer-risks": { "get": { "operationId": "aurax-bff-redirect-get-customer-risk-list", "tags": [ "customer-risks" ], "summary": "aurax-bff-redirect-get-customer-risk-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-customer-risk-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-risks", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountProductId", "declared_type": null, "nullable": true, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "CustomerRiskDto", "collection": true, "members": [ { "name": "CustomerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "QueryPurpose", "declared_type": "int", "nullable": false, "collection": false }, { "name": "QueryDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "TotalRiskAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerRiskDetails", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-customer-risk-list", "target_dapr_app_id": "risk-management-service", "target_route": "customer-risks", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-customer-risk-ui-bpmn", "tags": [ "customer-risks" ], "summary": "aurax-bff-redirect-create-customer-risk-ui-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-customer-risk-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-risks", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CustomerId", "declared_type": null, "nullable": true, "collection": false }, { "name": "QueryPurpose", "declared_type": null, "nullable": false, "collection": false }, { "name": "TotalRiskAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "CurrencyNumber", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/customer-risks/calculate": { "post": { "operationId": "aurax-bff-redirect-calculate-customer-risk-ui-bpmn", "tags": [ "customer-risks" ], "summary": "aurax-bff-redirect-calculate-customer-risk-ui-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-calculate-customer-risk-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-risks/calculate", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/customer-risks/{id}": { "get": { "operationId": "aurax-bff-redirect-get-customer-risk-by-id", "tags": [ "customer-risks" ], "summary": "aurax-bff-redirect-get-customer-risk-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-customer-risk-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-risks/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "CustomerRiskDto", "payload": "CustomerRiskDto", "collection": false, "members": [ { "name": "CustomerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "QueryPurpose", "declared_type": "int", "nullable": false, "collection": false }, { "name": "QueryDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "TotalRiskAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerRiskDetails", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-customer-risk-by-id", "target_dapr_app_id": "risk-management-service", "target_route": "customer-risks/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_RISKMNG_10", "status": 400, "message": { "ar": "لا يمكن العثور على مخاطر العميل: {0}", "en": "Customer risk cannot be found. :{0}", "tr": "Müşteri riski bulunamadı. : {0}" }, "message_available": true, "constant_name": "CUSTOMER_RISK_MUST_BE_NOT_NULL" } ] } } }, "/customer-risks/{id}/details": { "get": { "operationId": "aurax-bff-redirect-get-customer-ledger-risk-list-query", "tags": [ "customer-risks" ], "summary": "aurax-bff-redirect-get-customer-ledger-risk-list-query", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-customer-ledger-risk-list-query", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-risks/{id}/details", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/customer-rules": { "get": { "operationId": "aurax-bff-redirect-get-customer-rule-list", "tags": [ "customer-rules" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-customer-rule-list", "description": "Request and response fields are declared on the routing target `get-customer-rule-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "beginDate": { "type": "string", "format": "date-time", "x-aura-field-code": "beginDate" }, "code": { "type": "string", "x-aura-field-code": "customerRuleCode" }, "customerType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerType" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "formulaDefinitionId": { "type": "string", "format": "uuid", "x-aura-field-code": "formulaDefinitionId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerRuleId" }, "ruleType": { "type": "integer", "format": "int32", "x-aura-field-code": "ruleType" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-customer-rule-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-rules", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-customer-rule-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "post": { "operationId": "aurax-bff-redirect-create-customer-rule-ui-bpm", "tags": [ "customer-rules" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-create-customer-rule-ui-bpm", "description": "Request and response fields are declared on the routing target `create-customer-rule-ui-bpm`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "beginDate": { "type": "string", "format": "date-time", "x-aura-field-code": "beginDate" }, "code": { "type": "string", "x-aura-field-code": "code" }, "customerType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerType" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "formula": { "type": "string", "x-aura-field-code": "formula" }, "ruleType": { "type": "integer", "format": "int32", "x-aura-field-code": "ruleType" } }, "required": [ "code", "customerType", "formula", "ruleType" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 6, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-customer-rule-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-rules", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/customer-rules/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-customer-rule-ui-bpm", "tags": [ "customer-rules" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-delete-customer-rule-ui-bpm", "description": "Request and response fields are declared on the routing target `delete-customer-rule-ui-bpm`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "customerRuleId" } } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-customer-rule-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-rules/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "get": { "operationId": "aurax-bff-redirect-get-customer-rule-by-id", "tags": [ "customer-rules" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-customer-rule-by-id", "description": "Request and response fields are declared on the routing target `get-customer-rule-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "customerRuleId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "beginDate": { "type": "string", "format": "date-time", "x-aura-field-code": "beginDate" }, "code": { "type": "string", "x-aura-field-code": "customerRuleCode" }, "customerType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerType" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "formulaDefinitionId": { "type": "string", "format": "uuid", "x-aura-field-code": "formulaDefinitionId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerRuleId" }, "ruleType": { "type": "integer", "format": "int32", "x-aura-field-code": "ruleType" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-customer-rule-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-rules/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "put": { "operationId": "aurax-bff-redirect-edit-customer-rule-ui-bpm", "tags": [ "customer-rules" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-edit-customer-rule-ui-bpm", "description": "Request and response fields are declared on the routing target `edit-customer-rule-ui-bpm`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "customerRuleId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "beginDate": { "type": "string", "format": "date-time", "x-aura-field-code": "beginDate" }, "code": { "type": "string", "x-aura-field-code": "code" }, "customerType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerType" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "formula": { "type": "string", "x-aura-field-code": "formula" }, "formulaDefinitionId": { "type": "string", "format": "uuid", "x-aura-field-code": "formulaDefinitionId" }, "ruleType": { "type": "integer", "format": "int32", "x-aura-field-code": "ruleType" } }, "required": [ "code", "customerType", "formula", "formulaDefinitionId", "ruleType" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 7, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-edit-customer-rule-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-rules/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/customer-segments-range": { "get": { "operationId": "aurax-bff-redirect-get-customer-segment-range-list", "tags": [ "customer-segments-range" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-customer-segment-range-list", "description": "Request and response fields are declared on the routing target `get-customer-segment-range-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "customerRuleId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerRuleId" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "segmentRangeEndDate" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerSegmentRangeId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "maxValue": { "type": "integer", "format": "int32", "x-aura-field-code": "maxValue" }, "minValue": { "type": "integer", "format": "int32", "x-aura-field-code": "minValue" }, "segmentName": { "type": "string", "x-aura-field-code": "segmentName" }, "startDate": { "type": "string", "format": "date", "x-aura-field-code": "segmentRangeStartDate" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-customer-segment-range-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-segments-range", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-customer-segment-range-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "post": { "operationId": "aurax-bff-redirect-create-customer-segment-range-ui-bpm", "tags": [ "customer-segments-range" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-create-customer-segment-range-ui-bpm", "description": "Request and response fields are declared on the routing target `create-customer-segment-range-ui-bpm`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "customerRuleId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerRuleId" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "segmentEndDate" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "maxValue": { "type": "integer", "format": "int32", "x-aura-field-code": "maxValue" }, "minValue": { "type": "integer", "format": "int32", "x-aura-field-code": "minValue" }, "segmentName": { "type": "string", "x-aura-field-code": "segmentName" }, "startDate": { "type": "string", "format": "date", "x-aura-field-code": "segmentStartDate" } }, "required": [ "customerRuleId", "endDate", "isDefault", "maxValue", "minValue", "segmentName", "startDate" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 7, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-customer-segment-range-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-segments-range", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/customer-segments-range/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-customer-segment-range-ui-bpm", "tags": [ "customer-segments-range" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-delete-customer-segment-range-ui-bpm", "description": "Request and response fields are declared on the routing target `delete-customer-segment-range-ui-bpm`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "customerSegmentRangeId" } } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-customer-segment-range-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-segments-range/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "get": { "operationId": "aurax-bff-redirect-get-customer-segment-range-by-id", "tags": [ "customer-segments-range" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-customer-segment-range-by-id", "description": "Request and response fields are declared on the routing target `get-customer-segment-range-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "customerSegmentRangeId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "customerRuleId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerRuleId" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "segmentRangeEndDate" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerSegmentRangeId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "maxValue": { "type": "integer", "format": "int32", "x-aura-field-code": "maxValue" }, "minValue": { "type": "integer", "format": "int32", "x-aura-field-code": "minValue" }, "segmentName": { "type": "string", "x-aura-field-code": "segmentName" }, "startDate": { "type": "string", "format": "date", "x-aura-field-code": "segmentRangeStartDate" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-customer-segment-range-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-segments-range/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "put": { "operationId": "aurax-bff-redirect-update-customer-segment-range-ui-bpm", "tags": [ "customer-segments-range" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-update-customer-segment-range-ui-bpm", "description": "Request and response fields are declared on the routing target `update-customer-segment-range-ui-bpm`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "customerSegmentRangeId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "customerRuleId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerRuleId" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "segmentEndDate" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "maxValue": { "type": "integer", "format": "int32", "x-aura-field-code": "maxValue" }, "minValue": { "type": "integer", "format": "int32", "x-aura-field-code": "minValue" }, "segmentName": { "type": "string", "x-aura-field-code": "segmentName" }, "startDate": { "type": "string", "format": "date", "x-aura-field-code": "segmentStartDate" } }, "required": [ "customerRuleId", "endDate", "isActive", "isDefault", "maxValue", "minValue", "segmentName", "startDate" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 8, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-customer-segment-range-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-segments-range/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/customer-virtual-transactions": { "get": { "operationId": "aurax-bff-redirect-get-customer-virtual-transaction-list", "tags": [ "customer-virtual-transactions" ], "summary": "aurax-bff-redirect-get-customer-virtual-transaction-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-customer-virtual-transaction-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customer-virtual-transactions", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "CustomerVirtualTransactionDto", "collection": true, "members": [ { "name": "TransactionStatus", "declared_type": "int", "nullable": false, "collection": false }, { "name": "TransactionNo", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReceiverVirtualIban", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransactionDatetime", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "TransactionBankCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Amount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "AccountingEntryId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "LastProcessingDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "CurrencyId", "declared_type": "int?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-customer-virtual-transaction-list", "target_dapr_app_id": "loan-reconciliation-service", "target_route": "customer-virtual-transactions", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/customers": { "get": { "operationId": "aurax-bff-dynamic-get-customer-list", "tags": [ "customers" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-customer-list", "description": "Request and response fields are declared on the routing target `get-customer-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "birthCountryId": { "type": "integer", "format": "int32", "x-aura-field-code": "birthCountryId" }, "birthDate": { "type": "string", "format": "date", "x-aura-field-code": "birthDate" }, "birthPlace": { "type": "string", "x-aura-field-code": "birthPlace" }, "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "citizenidType": { "type": "integer", "format": "int32", "x-aura-field-code": "citizenidType" }, "closeDate": { "type": "string", "format": "date", "x-aura-field-code": "closeDate" }, "closedDate": { "type": "string", "format": "date", "x-aura-field-code": "closedDate" }, "closedReason": { "type": "integer", "format": "int32", "x-aura-field-code": "closedReason" }, "createdOrganizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "createdOrganizationId" }, "customerNumber": { "type": "string", "x-aura-field-code": "customerNumber" }, "customerStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "customerStatus" }, "customerSubType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerSubType" }, "customerType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerType" }, "deathDate": { "type": "string", "format": "date", "x-aura-field-code": "deathDate" }, "fatherName": { "type": "string", "x-aura-field-code": "fatherName" }, "freeZone": { "type": "integer", "format": "int32", "x-aura-field-code": "freeZone" }, "fullName": { "type": "string", "x-aura-field-code": "fullName" }, "gender": { "type": "integer", "format": "int32", "x-aura-field-code": "gender" }, "givenName": { "type": "string", "x-aura-field-code": "givenName" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "individualCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "individualCustomerId" }, "isBlackList": { "type": "boolean", "x-aura-field-code": "isBlackList" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "isFreeZoneCustomer": { "type": "boolean", "x-aura-field-code": "isFreeZoneCustomer" }, "isPoliticallyExposed": { "type": "boolean", "x-aura-field-code": "isPoliticallyExposed" }, "maidenSurname": { "type": "string", "x-aura-field-code": "maidenSurname" }, "mainOrganizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "mainOrganizationId" }, "maritalStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "maritalStatus" }, "middleName": { "type": "string", "x-aura-field-code": "middleName" }, "motherMaidenSurname": { "type": "string", "x-aura-field-code": "motherMaidenSurname" }, "motherName": { "type": "string", "x-aura-field-code": "motherName" }, "naceId": { "type": "string", "format": "uuid", "x-aura-field-code": "naceId" }, "name": { "type": "string", "x-aura-field-code": "firstName" }, "onboardedDate": { "type": "string", "format": "date", "x-aura-field-code": "customerOnboardedDate" }, "onboardedOrganizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "onboardedOrganizationId" }, "organizationType": { "type": "integer", "format": "int32", "x-aura-field-code": "organizationType" }, "profiles": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerProfileId" }, "profile": { "type": "integer", "format": "int32", "x-aura-field-code": "profile" } }, "x-aura-field-code": "profiles" } }, "recordType": { "type": "integer", "format": "int32", "x-aura-field-code": "recordType" }, "registryOfficeCountryDivisionId": { "type": "integer", "format": "int32", "x-aura-field-code": "registryOfficeCountryDivisionId" }, "registryOfficeCountryId": { "type": "integer", "format": "int32", "x-aura-field-code": "registryOfficeCountryId" }, "residency": { "type": "integer", "format": "int32", "x-aura-field-code": "residency" }, "subOrganizationType": { "type": "integer", "format": "int32", "x-aura-field-code": "subOrganizationType" }, "surname": { "type": "string", "x-aura-field-code": "surname", "x-aura-maskable": true }, "userId": { "type": "string", "format": "uuid", "x-aura-field-code": "userId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-customer-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customers", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-customer-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "post": { "operationId": "aurax-bff-dynamic-create-customer-ui-bpm", "tags": [ "customers" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "create-customer-ui-bpm.bpmn", "description": "Invokes the `aurax-bff-dynamic-create-customer-ui-bpm` service definition through `POST /customers`.\n\nRequest and response fields are declared on the routing target `create-customer-ui-bpm`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "addressFields": { "type": "array", "items": { "type": "object", "properties": { "fieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "addressTypeFieldId" }, "fieldValue": { "type": "string", "x-aura-field-code": "addressTypeFieldValue" } }, "x-aura-field-code": "addressFields" } }, "addressName": { "type": "string", "x-aura-field-code": "addressName" }, "addressType": { "type": "integer", "format": "int32", "x-aura-field-code": "addressType" }, "addressTypeId": { "type": "string", "format": "uuid", "x-aura-field-code": "addressTypeId" }, "building": { "type": "integer", "format": "int32", "x-aura-field-code": "country" }, "country": { "type": "integer", "format": "int32", "x-aura-field-code": "country" }, "district": { "type": "integer", "format": "int32", "x-aura-field-code": "country" }, "division": { "type": "integer", "format": "int32", "x-aura-field-code": "country" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "addressId" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "neighbourhood": { "type": "integer", "format": "int32", "x-aura-field-code": "country" }, "postCode": { "type": "string", "x-aura-field-code": "postCode" }, "rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "section": { "type": "integer", "format": "int32", "x-aura-field-code": "country" }, "street": { "type": "integer", "format": "int32", "x-aura-field-code": "country" } }, "required": [ "_rowStatus", "addressFields", "addressType", "addressTypeId", "isContact", "isDefault" ], "x-aura-field-code": "addresses" } }, "authorities": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "authorityType": { "type": "integer", "format": "int32", "x-aura-field-code": "authorityType" }, "description": { "type": "string", "x-aura-field-code": "description" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "startDate": { "type": "string", "format": "date-time", "x-aura-field-code": "startDate" }, "toCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "toCustomerId" } }, "x-aura-field-code": "authorities" } }, "birthCountryId": { "type": "integer", "format": "int32", "x-aura-field-code": "birthCountryId" }, "birthDate": { "type": "string", "format": "date", "x-aura-field-code": "birthDate" }, "birthPlace": { "type": "string", "x-aura-field-code": "birthPlace" }, "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "citizenidType": { "type": "integer", "format": "int32", "x-aura-field-code": "citizenidType" }, "consentItemIds": { "type": "array", "items": { "type": "string", "x-aura-field-code": "consentItemIds" } }, "createdOrganizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "createdOrganizationId" }, "customerAttributes": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "attributeKey": { "type": "integer", "format": "int32", "x-aura-field-code": "attributeKey" }, "attributeValue": { "type": "string", "x-aura-field-code": "attributeValue" }, "beginDate": { "type": "string", "format": "date", "x-aura-field-code": "attributeBeginDate" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "isDigital": { "type": "boolean", "x-aura-field-code": "isDigital" } }, "x-aura-field-code": "customerAttributes" } }, "customerNumber": { "type": "string", "x-aura-field-code": "customerNumber" }, "customerSubType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerSubType" }, "customerTaxpayers": { "type": "array", "items": { "type": "object", "properties": { "countryId": { "type": "integer", "format": "int32", "x-aura-field-code": "countryId" }, "description": { "type": "string", "x-aura-field-code": "description" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "taxpayerId" }, "taxNumber": { "type": "string", "x-aura-field-code": "taxNumber" }, "taxpayerType": { "type": "integer", "format": "int32", "x-aura-field-code": "taxpayerType" } }, "required": [ "countryId", "taxNumber", "taxpayerType" ], "x-aura-field-code": "customerTaxpayers" } }, "customerType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerType" }, "deathDate": { "type": "string", "format": "date", "x-aura-field-code": "deathDate" }, "dmsId": { "type": "string", "format": "uuid", "x-aura-field-code": "dmsId" }, "emails": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "email": { "type": "string", "x-aura-field-code": "email" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "emailId" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" } }, "required": [ "_rowStatus", "email", "isContact", "isDefault" ], "x-aura-field-code": "emails" } }, "fatherName": { "type": "string", "x-aura-field-code": "fatherName" }, "fullName": { "type": "string", "x-aura-field-code": "fullName" }, "gender": { "type": "integer", "format": "int32", "x-aura-field-code": "gender" }, "givenName": { "type": "string", "x-aura-field-code": "givenName" }, "identities": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "identityFields": { "type": "array", "items": { "type": "object", "properties": { "fieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "identityTypeFieldId" }, "fieldValue": { "type": "string", "x-aura-field-code": "identityTypeFieldValue" } }, "required": [ "fieldId", "fieldValue" ], "x-aura-field-code": "identityTypeFields" } }, "identityTypeId": { "type": "string", "format": "uuid", "x-aura-field-code": "identityTypeId" } }, "required": [ "_rowStatus", "identityFields", "identityTypeId" ], "x-aura-field-code": "identities" } }, "isPoliticallyExposed": { "type": "boolean", "x-aura-field-code": "isPoliticallyExposed" }, "maidenSurname": { "type": "string", "x-aura-field-code": "maidenSurname" }, "mainOrganizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "mainOrganizationId" }, "maritalStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "maritalStatus" }, "middleName": { "type": "string", "x-aura-field-code": "middleName" }, "motherMaidenSurname": { "type": "string", "x-aura-field-code": "motherMaidenSurname" }, "motherName": { "type": "string", "x-aura-field-code": "motherName" }, "naceId": { "type": "string", "format": "uuid", "x-aura-field-code": "naceId" }, "name": { "type": "string", "x-aura-field-code": "firstName" }, "nationalities": { "type": "array", "items": { "type": "object", "properties": { "countryId": { "type": "integer", "format": "int32", "x-aura-field-code": "countryId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "nationalityId" }, "priority": { "type": "integer", "format": "int32", "x-aura-field-code": "priority" } }, "required": [ "countryId", "priority" ], "x-aura-field-code": "nationalities" } }, "occupations": { "type": "array", "items": { "type": "object", "properties": { "fieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "occupationTypeFieldId" }, "fieldValue": { "type": "string", "x-aura-field-code": "occupationTypeFieldValue" }, "typeId": { "type": "string", "format": "uuid", "x-aura-field-code": "occupationTypeId" } }, "required": [ "typeId" ], "x-aura-field-code": "occupations" } }, "onboardedOrganizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "onboardedOrganizationId" }, "personRegistration": { "type": "boolean", "x-aura-field-code": "personRegistration" }, "phones": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "phoneId" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "phoneNumber": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true }, "phoneType": { "type": "integer", "format": "int32", "x-aura-field-code": "phoneType" } }, "required": [ "isContact", "isDefault", "phoneNumber", "phoneType" ], "x-aura-field-code": "phones" } }, "profiles": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "profileId" }, "profile": { "type": "integer", "format": "int32", "x-aura-field-code": "profile" } }, "x-aura-field-code": "profiles" } }, "relations": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "description": { "type": "string", "x-aura-field-code": "authorityDescription" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "relationType": { "type": "integer", "format": "int32", "x-aura-field-code": "relationType" }, "startDate": { "type": "string", "format": "date-time", "x-aura-field-code": "startDate" }, "toCitizenid": { "type": "string", "x-aura-field-code": "toCitizenid" }, "toCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "toCustomerId" } }, "x-aura-field-code": "relations" } }, "reserveCustomerNumber": { "type": "boolean", "x-aura-field-code": "reserveCustomerNumber" }, "residency": { "type": "integer", "format": "int32", "x-aura-field-code": "residency" }, "residentials": { "type": "array", "items": { "type": "object", "properties": { "countryId": { "type": "integer", "format": "int32", "x-aura-field-code": "countryId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "residentialId" }, "priority": { "type": "integer", "format": "int32", "x-aura-field-code": "priority" } }, "required": [ "countryId", "priority" ], "x-aura-field-code": "residentials" } }, "sectorNaceId": { "type": "string", "format": "uuid", "x-aura-field-code": "sectorNaceId" }, "surname": { "type": "string", "x-aura-field-code": "surname", "x-aura-maskable": true } }, "required": [ "birthDate", "citizenid", "citizenidType", "createdOrganizationId", "customerSubType", "customerType", "isPoliticallyExposed", "mainOrganizationId", "name", "onboardedOrganizationId", "surname" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 43, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-create-customer-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customers", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/customers-with-contacts": { "get": { "operationId": "aurax-bff-redirect-get-customer-list-with-contact", "tags": [ "customers-with-contacts" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-customer-list-with-contact", "description": "Request and response fields are declared on the routing target `get-customer-list-with-contact`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "customerNumber": { "type": "string", "x-aura-field-code": "customerNumber" }, "customerStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "customerStatus" }, "customerSubType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerSubType" }, "customerType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerType" }, "fullName": { "type": "string", "x-aura-field-code": "fullName" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "phoneNumber": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true }, "phoneType": { "type": "integer", "format": "int32", "x-aura-field-code": "phoneType" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "customerNumber": { "type": "string", "x-aura-field-code": "customerNumber" }, "customerStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "customerStatus" }, "customerSubType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerSubType" }, "customerType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerType" }, "fullName": { "type": "string", "x-aura-field-code": "fullName" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "phoneNumber": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true }, "phoneType": { "type": "integer", "format": "int32", "x-aura-field-code": "phoneType" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "customerNumber": { "type": "string", "x-aura-field-code": "customerNumber" }, "customerStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "customerStatus" }, "customerSubType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerSubType" }, "customerType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerType" }, "fullName": { "type": "string", "x-aura-field-code": "fullName" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "phoneNumber": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true }, "phoneType": { "type": "integer", "format": "int32", "x-aura-field-code": "phoneType" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-customer-list-with-contact", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customers-with-contacts", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-customer-list-with-contact`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/customers/bnpl-virtual-ibans": { "get": { "operationId": "aurax-bff-redirect-get-virtual-iban-list", "tags": [ "customers" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-virtual-iban-list", "description": "Request and response fields are declared on the routing target `get-bnpl-virtual-iban-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "closeDate": { "type": "string", "format": "date", "x-aura-field-code": "closeDate" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "fec": { "type": "integer", "format": "int32", "x-aura-field-code": "fec" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "bnplVirtualIbanId" }, "virtualIban": { "type": "string", "x-aura-field-code": "virtualIban" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-virtual-iban-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customers/bnpl-virtual-ibans", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "note": "Platform-provided behaviours declared on the routing target `get-bnpl-virtual-iban-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/customers/{id}": { "get": { "operationId": "aurax-bff-dynamic-get-customer-by-id", "tags": [ "customers" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-customer-by-id", "description": "Request and response fields are declared on the routing target `get-customer-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "type": "object", "properties": { "addressDetails": { "type": "array", "items": { "type": "object", "properties": { "fieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "addressTypeFieldId" }, "fieldValue": { "type": "string", "x-aura-field-code": "addressTypeFieldValue" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "addressDetailId" } }, "x-aura-field-code": "addressDetails" } }, "addressName": { "type": "string", "x-aura-field-code": "addressName" }, "addressType": { "type": "integer", "format": "int32", "x-aura-field-code": "addressType" }, "addressTypeId": { "type": "string", "format": "uuid", "x-aura-field-code": "addressTypeId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "addressId" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "separatorMark": { "type": "string", "x-aura-field-code": "separatorMark" } }, "x-aura-field-code": "addresses" } }, "birthCountryId": { "type": "integer", "format": "int32", "x-aura-field-code": "birthCountryId" }, "birthDate": { "type": "string", "format": "date", "x-aura-field-code": "birthDate" }, "birthPlace": { "type": "string", "x-aura-field-code": "birthPlace" }, "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "citizenidType": { "type": "integer", "format": "int32", "x-aura-field-code": "citizenidType" }, "closeDate": { "type": "string", "format": "date", "x-aura-field-code": "closeDate" }, "closedDate": { "type": "string", "format": "date", "x-aura-field-code": "closedDate" }, "closedReason": { "type": "integer", "format": "int32", "x-aura-field-code": "closedReason" }, "consentItemIds": { "type": "array", "items": { "type": "string", "format": "uuid", "x-aura-field-code": "consentItemGuidIds" } }, "corporateCustomer": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "establishCountryDivisionId": { "type": "integer", "format": "int32", "x-aura-field-code": "establishCountryDivisionId" }, "establishCountryId": { "type": "integer", "format": "int32", "x-aura-field-code": "establishCountryId" }, "establishDate": { "type": "string", "format": "date", "x-aura-field-code": "establishDate" }, "freeZone": { "type": "integer", "format": "int32", "x-aura-field-code": "freeZone" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "corporateCustomerId" }, "isFreeZoneCustomer": { "type": "boolean", "x-aura-field-code": "isFreeZoneCustomer" }, "legalOrganizationType": { "type": "integer", "format": "int32", "x-aura-field-code": "legalOrganizationType" }, "naceId": { "type": "string", "format": "uuid", "x-aura-field-code": "naceId" }, "organizationType": { "type": "integer", "format": "int32", "x-aura-field-code": "organizationType" }, "registryOfficeCountryDivisionId": { "type": "integer", "format": "int32", "x-aura-field-code": "registryOfficeCountryDivisionId" }, "registryOfficeCountryId": { "type": "integer", "format": "int32", "x-aura-field-code": "registryOfficeCountryId" }, "shortName": { "type": "string", "x-aura-field-code": "shortName" }, "subOrganizationType": { "type": "integer", "format": "int32", "x-aura-field-code": "subOrganizationType" }, "taxOfficeId": { "type": "string", "format": "uuid", "x-aura-field-code": "taxOfficeId" }, "title": { "type": "string", "x-aura-field-code": "title" }, "tradeRegisterNumber": { "type": "string", "x-aura-field-code": "tradeRegisterNumber" } }, "x-aura-field-code": "corporateCustomer" }, "createdOrganizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "createdOrganizationId" }, "customerAttributes": { "type": "array", "items": { "type": "object", "properties": { "attributeKey": { "type": "integer", "format": "int32", "x-aura-field-code": "attributeKey" }, "attributeValue": { "type": "string", "x-aura-field-code": "attributeValue" }, "beginDate": { "type": "string", "format": "date", "x-aura-field-code": "attributeBeginDate" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerAttributeId" }, "isDigital": { "type": "boolean", "x-aura-field-code": "isDigital" } }, "x-aura-field-code": "customerAttributes" } }, "customerAuthorities": { "type": "array", "items": { "type": "object", "properties": { "authorityType": { "type": "integer", "format": "int32", "x-aura-field-code": "authorityType" }, "description": { "type": "string", "x-aura-field-code": "description" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "fromCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "fromCustomerId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerAuthorityId" }, "startDate": { "type": "string", "format": "date-time", "x-aura-field-code": "startDate" }, "toCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "toCustomerId" } }, "x-aura-field-code": "customerAuthorities" } }, "customerChecks": { "type": "array", "items": { "type": "object", "properties": { "changedType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerCheckChangedType" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerCheckId" } }, "x-aura-field-code": "customerChecks" } }, "customerNumber": { "type": "string", "x-aura-field-code": "customerNumber" }, "customerRelationships": { "type": "array", "items": { "type": "object", "properties": { "customerShareholders": { "type": "array", "items": { "type": "object", "properties": { "customerRelationshipId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerRelationshipId" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerShareholderId" }, "shareRate": { "type": "number", "format": "decimal", "x-aura-field-code": "shareRate" }, "startDate": { "type": "string", "format": "date-time", "x-aura-field-code": "startDate" } }, "x-aura-field-code": "customerShareholders" } }, "description": { "type": "string", "x-aura-field-code": "authorityDescription" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "fromCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "fromCustomerId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerRelationshipId" }, "relationType": { "type": "integer", "format": "int32", "x-aura-field-code": "relationType" }, "startDate": { "type": "string", "format": "date-time", "x-aura-field-code": "startDate" }, "toCitizenid": { "type": "string", "x-aura-field-code": "toCitizenid" }, "toCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "toCustomerId" } }, "x-aura-field-code": "customerRelationships" } }, "customerStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "customerStatus" }, "customerSubType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerSubType" }, "customerTaxpayers": { "type": "array", "items": { "type": "object", "properties": { "countryId": { "type": "integer", "format": "int32", "x-aura-field-code": "countryId" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "description": { "type": "string", "x-aura-field-code": "description" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "taxpayerId" }, "taxNumber": { "type": "string", "x-aura-field-code": "taxNumber" }, "taxpayerType": { "type": "integer", "format": "int32", "x-aura-field-code": "taxpayerType" } }, "x-aura-field-code": "customerTaxpayers" } }, "customerType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerType" }, "deathDate": { "type": "string", "format": "date", "x-aura-field-code": "deathDate" }, "emails": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string", "x-aura-field-code": "email" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "emailId" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" } }, "x-aura-field-code": "emails" } }, "fatherName": { "type": "string", "x-aura-field-code": "fatherName" }, "freeZone": { "type": "integer", "format": "int32", "x-aura-field-code": "freeZone" }, "fullName": { "type": "string", "x-aura-field-code": "fullName" }, "gender": { "type": "integer", "format": "int32", "x-aura-field-code": "gender" }, "givenName": { "type": "string", "x-aura-field-code": "givenName" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "identities": { "type": "array", "items": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "identityCardId" }, "identityDetails": { "type": "array", "items": { "type": "object", "properties": { "fieldValue": { "type": "string", "x-aura-field-code": "identityTypeFieldValue" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "identityCardDetailId" }, "identityTypeFieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "identityTypeFieldId" } }, "x-aura-field-code": "identityDetails" } }, "identityTypeId": { "type": "string", "format": "uuid", "x-aura-field-code": "identityTypeId" } }, "x-aura-field-code": "identities" } }, "individualCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "individualCustomerId" }, "isBlackList": { "type": "boolean", "x-aura-field-code": "isBlackList" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "isFreeZoneCustomer": { "type": "boolean", "x-aura-field-code": "isFreeZoneCustomer" }, "isPoliticallyExposed": { "type": "boolean", "x-aura-field-code": "isPoliticallyExposed" }, "maidenSurname": { "type": "string", "x-aura-field-code": "maidenSurname" }, "mainOrganizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "mainOrganizationId" }, "maritalStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "maritalStatus" }, "middleName": { "type": "string", "x-aura-field-code": "middleName" }, "motherMaidenSurname": { "type": "string", "x-aura-field-code": "motherMaidenSurname" }, "motherName": { "type": "string", "x-aura-field-code": "motherName" }, "naceId": { "type": "string", "format": "uuid", "x-aura-field-code": "naceId" }, "name": { "type": "string", "x-aura-field-code": "firstName" }, "nationalities": { "type": "array", "items": { "type": "object", "properties": { "countryId": { "type": "integer", "format": "int32", "x-aura-field-code": "countryId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "nationalityId" }, "priority": { "type": "integer", "format": "int32", "x-aura-field-code": "priority" } }, "x-aura-field-code": "nationalities" } }, "occupations": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "occupationId" }, "occupationTypeFieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "occupationTypeFieldId" }, "occupationTypeFieldValue": { "type": "string", "x-aura-field-code": "occupationTypeFieldValue" }, "occupationTypeId": { "type": "string", "format": "uuid", "x-aura-field-code": "occupationTypeId" } }, "x-aura-field-code": "occupations" } }, "onboardedDate": { "type": "string", "format": "date", "x-aura-field-code": "customerOnboardedDate" }, "onboardedOrganizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "onboardedOrganizationId" }, "organizationType": { "type": "integer", "format": "int32", "x-aura-field-code": "organizationType" }, "phones": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "phoneId" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "phoneNumber": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true }, "phoneType": { "type": "integer", "format": "int32", "x-aura-field-code": "phoneType" } }, "x-aura-field-code": "phones" } }, "profiles": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerProfileId" }, "profile": { "type": "integer", "format": "int32", "x-aura-field-code": "profile" } }, "x-aura-field-code": "profiles" } }, "recordType": { "type": "integer", "format": "int32", "x-aura-field-code": "recordType" }, "registryOfficeCountryDivisionId": { "type": "integer", "format": "int32", "x-aura-field-code": "registryOfficeCountryDivisionId" }, "registryOfficeCountryId": { "type": "integer", "format": "int32", "x-aura-field-code": "registryOfficeCountryId" }, "residency": { "type": "integer", "format": "int32", "x-aura-field-code": "residency" }, "residentials": { "type": "array", "items": { "type": "object", "properties": { "countryId": { "type": "integer", "format": "int32", "x-aura-field-code": "countryId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "residentialId" }, "priority": { "type": "integer", "format": "int32", "x-aura-field-code": "priority" } }, "x-aura-field-code": "residentials" } }, "subOrganizationType": { "type": "integer", "format": "int32", "x-aura-field-code": "subOrganizationType" }, "surname": { "type": "string", "x-aura-field-code": "surname", "x-aura-maskable": true }, "unlimitedCompanyCustomer": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "establishedDate": { "type": "string", "format": "date", "x-aura-field-code": "establishedDate" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "unlimitedCompanyCustomerId" }, "taxOfficeId": { "type": "string", "format": "uuid", "x-aura-field-code": "taxOfficeId" }, "title": { "type": "string", "x-aura-field-code": "unlimitedCompanyCustomerTitle" } }, "x-aura-field-code": "unlimitedCompanyCustomer" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-customer-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customers/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "no-members" }, "x-aura-code-response": { "state": "structure", "declared_type": "CustomerDetailDto", "payload": "CustomerDetailDto", "collection": false, "members": [ { "name": "CorporateCustomer", "declared_type": "CorporateCustomerDto", "nullable": false, "collection": false }, { "name": "UnlimitedCompanyCustomer", "declared_type": "UnlimitedCompanyCustomerDto", "nullable": false, "collection": false }, { "name": "Addresses", "declared_type": "List", "nullable": false, "collection": true }, { "name": "AddressesUI", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Emails", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Identities", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Nationalities", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Occupations", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Phones", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Residentials", "declared_type": "List", "nullable": false, "collection": true }, { "name": "ConsentItemIds", "declared_type": "List", "nullable": false, "collection": true }, { "name": "CustomerChecks", "declared_type": "List", "nullable": false, "collection": true }, { "name": "CustomerAuthorities", "declared_type": "List", "nullable": false, "collection": true }, { "name": "CustomerRelationships", "declared_type": "List", "nullable": false, "collection": true }, { "name": "CustomerTaxpayers", "declared_type": "List", "nullable": false, "collection": true }, { "name": "CustomerAttributes", "declared_type": "List", "nullable": false, "collection": true }, { "name": "CustomerRepresentativeAssignments", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." } }, "put": { "operationId": "aurax-bff-dynamic-edit-customer-ui-bpm", "tags": [ "customers" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "update-customer-ui-bpm.bpmn", "description": "Invokes the `aurax-bff-dynamic-edit-customer-ui-bpm` service definition through `PUT /customers/{id}`.\n\nRequest and response fields are declared on the routing target `edit-customer-ui-bpm`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in this route template but not among the Route-bound fields of the routing target `edit-customer-ui-bpm`, whose own path is decoupled from this one.", "x-aura-source": "route-template-only-after-collapse" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "addressFields": { "type": "array", "items": { "type": "object", "properties": { "fieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "addressTypeFieldId" }, "fieldValue": { "type": "string", "x-aura-field-code": "addressTypeFieldValue" } }, "required": [ "fieldId", "fieldValue" ], "x-aura-field-code": "addressFields" } }, "addressId": { "type": "string", "format": "uuid", "x-aura-field-code": "addressId" }, "addressName": { "type": "string", "x-aura-field-code": "addressName" }, "addressType": { "type": "integer", "format": "int32", "x-aura-field-code": "addressType" }, "addressTypeId": { "type": "string", "format": "uuid", "x-aura-field-code": "addressTypeId" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" } }, "required": [ "_rowStatus", "addressFields", "addressType", "addressTypeId", "isContact", "isDefault" ], "x-aura-field-code": "addresses" } }, "authorities": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "authorityType": { "type": "integer", "format": "int32", "x-aura-field-code": "authorityType" }, "description": { "type": "string", "x-aura-field-code": "authorityDescription" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerAuthorityId" }, "startDate": { "type": "string", "format": "date-time", "x-aura-field-code": "startDate" }, "toCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "toCustomerId" } }, "x-aura-field-code": "authorities" } }, "birthCountryId": { "type": "integer", "format": "int32", "x-aura-field-code": "birthCountryId" }, "birthDate": { "type": "string", "format": "date", "x-aura-field-code": "birthDate" }, "birthPlace": { "type": "string", "x-aura-field-code": "birthPlace" }, "changeStatus": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "closedReason": { "type": "integer", "format": "int32", "x-aura-field-code": "closedReason" }, "customerStatus": { "type": "string", "format": "date", "x-aura-field-code": "closedDate" } }, "required": [ "_rowStatus" ], "x-aura-field-code": "changeStatus" } }, "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "citizenidType": { "type": "integer", "format": "int32", "x-aura-field-code": "citizenidType" }, "closedDate": { "type": "string", "format": "date", "x-aura-field-code": "closedDate" }, "consentItemIds": { "type": "array", "items": { "type": "string", "x-aura-field-code": "consentItemIds" } }, "createdOrganizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "createdOrganizationId" }, "customerAttributes": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "attributeKey": { "type": "integer", "format": "int32", "x-aura-field-code": "attributeKey" }, "attributeValue": { "type": "string", "x-aura-field-code": "attributeValue" }, "beginDate": { "type": "string", "format": "date", "x-aura-field-code": "attributeBeginDate" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerAttributeId" }, "isDigital": { "type": "boolean", "x-aura-field-code": "isDigital" } }, "x-aura-field-code": "customerAttributes" } }, "customerSubType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerSubType" }, "customerTaxpayers": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "countryId": { "type": "integer", "format": "int32", "x-aura-field-code": "countryId" }, "description": { "type": "string", "x-aura-field-code": "description" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "taxpayerId" }, "taxNumber": { "type": "string", "x-aura-field-code": "taxNumber" }, "taxpayerId": { "type": "string", "format": "uuid", "x-aura-field-code": "taxpayerId" }, "taxpayerType": { "type": "integer", "format": "int32", "x-aura-field-code": "taxpayerType" } }, "required": [ "_rowStatus", "countryId", "taxNumber", "taxpayerType" ], "x-aura-field-code": "customerTaxpayers" } }, "customerType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerType" }, "deathDate": { "type": "string", "format": "date", "x-aura-field-code": "deathDate" }, "emails": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "email": { "type": "string", "x-aura-field-code": "email" }, "emailId": { "type": "string", "format": "uuid", "x-aura-field-code": "emailId" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "isVerified": { "type": "boolean", "x-aura-field-code": "isVerified" }, "mailId": { "type": "string", "format": "uuid", "x-aura-field-code": "mailId" } }, "required": [ "_rowStatus", "email", "isContact", "isDefault" ], "x-aura-field-code": "emails" } }, "fatherName": { "type": "string", "x-aura-field-code": "fatherName" }, "fullName": { "type": "string", "x-aura-field-code": "fullName" }, "gender": { "type": "integer", "format": "int32", "x-aura-field-code": "gender" }, "givenName": { "type": "string", "x-aura-field-code": "givenName" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "identities": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "identityCardId": { "type": "string", "format": "uuid", "x-aura-field-code": "identityCardId" }, "identityFields": { "type": "array", "items": { "type": "object", "properties": { "fieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "identityTypeFieldId" }, "fieldValue": { "type": "string", "x-aura-field-code": "identityTypeFieldValue" } }, "required": [ "fieldId", "fieldValue" ], "x-aura-field-code": "identityTypeFields" } }, "identityTypeId": { "type": "string", "format": "uuid", "x-aura-field-code": "identityTypeId" } }, "required": [ "_rowStatus", "identityFields", "identityTypeId" ], "x-aura-field-code": "identities" } }, "individualCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "individualCustomerId" }, "isPoliticallyExposed": { "type": "boolean", "x-aura-field-code": "isPoliticallyExposed" }, "maidenSurname": { "type": "string", "x-aura-field-code": "maidenSurname" }, "mainOrganizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "mainOrganizationId" }, "maritalStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "maritalStatus" }, "middleName": { "type": "string", "x-aura-field-code": "middleName" }, "motherMaidenSurname": { "type": "string", "x-aura-field-code": "motherMaidenSurname" }, "motherName": { "type": "string", "x-aura-field-code": "motherName" }, "naceId": { "type": "string", "format": "uuid", "x-aura-field-code": "naceId" }, "name": { "type": "string", "x-aura-field-code": "firstName" }, "nationalities": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "countryId": { "type": "integer", "format": "int32", "x-aura-field-code": "countryId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "nationalityId" }, "nationalityId": { "type": "string", "format": "uuid", "x-aura-field-code": "nationalityId" }, "priority": { "type": "integer", "format": "int32", "x-aura-field-code": "priority" } }, "required": [ "_rowStatus", "countryId", "priority" ], "x-aura-field-code": "nationalities" } }, "occupations": { "type": "array", "items": { "type": "object", "properties": { "fieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "occupationTypeFieldId" }, "fieldValue": { "type": "string", "x-aura-field-code": "occupationTypeFieldValue" }, "typeId": { "type": "string", "format": "uuid", "x-aura-field-code": "occupationTypeId" } }, "required": [ "typeId" ], "x-aura-field-code": "occupations" } }, "onboardedOrganizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "onboardedOrganizationId" }, "phones": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "phoneId": { "type": "string", "format": "uuid", "x-aura-field-code": "phoneId" }, "phoneNumber": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true }, "phoneType": { "type": "integer", "format": "int32", "x-aura-field-code": "phoneType" } }, "required": [ "_rowStatus", "isContact", "isDefault", "phoneNumber", "phoneType" ], "x-aura-field-code": "phones" } }, "profiles": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "customerProfileId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerProfileId" }, "profile": { "type": "integer", "format": "int32", "x-aura-field-code": "profile" } }, "x-aura-field-code": "profiles" } }, "relations": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "description": { "type": "string", "x-aura-field-code": "authorityDescription" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerRelationshipId" }, "relationType": { "type": "integer", "format": "int32", "x-aura-field-code": "relationType" }, "startDate": { "type": "string", "format": "date-time", "x-aura-field-code": "startDate" }, "toCitizenid": { "type": "string", "x-aura-field-code": "toCitizenid" }, "toCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "toCustomerId" } }, "x-aura-field-code": "relations" } }, "residency": { "type": "integer", "format": "int32", "x-aura-field-code": "residency" }, "residentials": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "countryId": { "type": "integer", "format": "int32", "x-aura-field-code": "countryId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "residentialId" }, "priority": { "type": "integer", "format": "int32", "x-aura-field-code": "priority" }, "residentialId": { "type": "string", "format": "uuid", "x-aura-field-code": "residentialId" } }, "required": [ "_rowStatus", "countryId", "priority" ], "x-aura-field-code": "residentials" } }, "sectorNaceId": { "type": "string", "format": "uuid", "x-aura-field-code": "sectorNaceId" }, "surname": { "type": "string", "x-aura-field-code": "surname", "x-aura-maskable": true }, "taxNo": { "type": "string", "x-aura-field-code": "taxNo" } }, "required": [ "birthDate", "changeStatus", "citizenid", "citizenidType", "createdOrganizationId", "customerSubType", "customerType", "id", "individualCustomerId", "isPoliticallyExposed", "mainOrganizationId", "name", "onboardedOrganizationId", "surname" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 44, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-edit-customer-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customers/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/customers/{id}/accounts/balances": { "get": { "operationId": "aurax-bff-redirect-get-account-total-balance", "tags": [ "customers" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-account-total-balance", "description": "Request and response fields are declared on the routing target `get-account-total-balance`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-account-total-balance", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customers/{id}/accounts/balances", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-account-total-balance`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/customers/{id}/accounts/details": { "get": { "operationId": "aurax-bff-redirect-get-account-details", "tags": [ "customers" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-account-details", "description": "Request and response fields are declared on the routing target `get-account-details`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-account-details", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customers/{id}/accounts/details", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-account-details`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/customers/{id}/addresses": { "get": { "operationId": "aurax-bff-redirect-get-address-by-customer-id", "tags": [ "customers" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-address-by-customer-id", "description": "Request and response fields are declared on the routing target `get-address-by-customer-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "addressFields": { "type": "array", "items": { "type": "object", "properties": { "fieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "fieldId" }, "fieldValue": { "type": "string", "x-aura-field-code": "fieldValue" } }, "x-aura-field-code": "addressFields" } }, "addressName": { "type": "string", "x-aura-field-code": "addressName" }, "addressText": { "type": "string", "x-aura-field-code": "addressText" }, "addressType": { "type": "integer", "format": "int32", "x-aura-field-code": "addressType" }, "addressTypeId": { "type": "string", "format": "uuid", "x-aura-field-code": "addressTypeId" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "isCardDeliveryAddress": { "type": "boolean", "x-aura-field-code": "isCardDeliveryAddress" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "isVerified": { "type": "boolean", "x-aura-field-code": "isVerified" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "addressFields": { "type": "array", "items": { "type": "object", "properties": { "fieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "fieldId" }, "fieldValue": { "type": "string", "x-aura-field-code": "fieldValue" } }, "x-aura-field-code": "addressFields" } }, "addressName": { "type": "string", "x-aura-field-code": "addressName" }, "addressText": { "type": "string", "x-aura-field-code": "addressText" }, "addressType": { "type": "integer", "format": "int32", "x-aura-field-code": "addressType" }, "addressTypeId": { "type": "string", "format": "uuid", "x-aura-field-code": "addressTypeId" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "isCardDeliveryAddress": { "type": "boolean", "x-aura-field-code": "isCardDeliveryAddress" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "isVerified": { "type": "boolean", "x-aura-field-code": "isVerified" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "addressFields": { "type": "array", "items": { "type": "object", "properties": { "fieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "fieldId" }, "fieldValue": { "type": "string", "x-aura-field-code": "fieldValue" } }, "x-aura-field-code": "addressFields" } }, "addressName": { "type": "string", "x-aura-field-code": "addressName" }, "addressText": { "type": "string", "x-aura-field-code": "addressText" }, "addressType": { "type": "integer", "format": "int32", "x-aura-field-code": "addressType" }, "addressTypeId": { "type": "string", "format": "uuid", "x-aura-field-code": "addressTypeId" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "isCardDeliveryAddress": { "type": "boolean", "x-aura-field-code": "isCardDeliveryAddress" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "isVerified": { "type": "boolean", "x-aura-field-code": "isVerified" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-address-by-customer-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customers/{id}/addresses", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/customers/{id}/attributes": { "get": { "operationId": "aurax-bff-redirect-get-customer-attribute-list-by-customer-id", "tags": [ "customers" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-customer-attribute-list-by-customer-id", "description": "Request and response fields are declared on the routing target `get-customer-attribute-list-by-customer-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "x-aura-type": "unresolved" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "attributeKey": { "type": "integer", "format": "int32", "x-aura-field-code": "attributeKey" }, "attributeValue": { "type": "string", "x-aura-field-code": "attributeValue" }, "beginDate": { "x-aura-type": "unresolved" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "id": { "x-aura-type": "unresolved" }, "isDigital": { "type": "boolean", "x-aura-field-code": "isDigital" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "attributeKey": { "type": "integer", "format": "int32", "x-aura-field-code": "attributeKey" }, "attributeValue": { "type": "string", "x-aura-field-code": "attributeValue" }, "beginDate": { "x-aura-type": "unresolved" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "id": { "x-aura-type": "unresolved" }, "isDigital": { "type": "boolean", "x-aura-field-code": "isDigital" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "attributeKey": { "type": "integer", "format": "int32", "x-aura-field-code": "attributeKey" }, "attributeValue": { "type": "string", "x-aura-field-code": "attributeValue" }, "beginDate": { "x-aura-type": "unresolved" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "id": { "x-aura-type": "unresolved" }, "isDigital": { "type": "boolean", "x-aura-field-code": "isDigital" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-customer-attribute-list-by-customer-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customers/{id}/attributes", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/customers/{id}/bnpl-virtual-ibans": { "get": { "operationId": "aurax-bff-redirect-get-bnpl-virtual-iban-by-customer-id", "tags": [ "customers" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-bnpl-virtual-iban-by-customer-id", "description": "Request and response fields are declared on the routing target `get-bnpl-virtual-iban-by-customer-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "closeDate": { "type": "string", "format": "date", "x-aura-field-code": "closeDate" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "fec": { "type": "integer", "format": "int32", "x-aura-field-code": "fec" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "bnplVirtualIbanId" }, "virtualIban": { "type": "string", "x-aura-field-code": "virtualIban" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-bnpl-virtual-iban-by-customer-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customers/{id}/bnpl-virtual-ibans", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/customers/{id}/emails": { "get": { "operationId": "aurax-bff-redirect-get-email-address-by-customer-id", "tags": [ "customers" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-email-address-by-customer-id", "description": "Request and response fields are declared on the routing target `get-email-address-by-customer-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "email": { "type": "string", "x-aura-field-code": "email" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "isVerified": { "type": "boolean", "x-aura-field-code": "isVerified" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "email": { "type": "string", "x-aura-field-code": "email" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "isVerified": { "type": "boolean", "x-aura-field-code": "isVerified" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "email": { "type": "string", "x-aura-field-code": "email" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "isVerified": { "type": "boolean", "x-aura-field-code": "isVerified" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-email-address-by-customer-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customers/{id}/emails", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/customers/{id}/identity-cards": { "get": { "operationId": "aurax-bff-redirect-get-identity-card-by-customer-id", "tags": [ "customers" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-identity-card-by-customer-id", "description": "Request and response fields are declared on the routing target `get-identity-card-by-customer-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "identityCardDetails": { "type": "array", "items": { "type": "object", "properties": { "fieldValue": { "type": "string", "x-aura-field-code": "fieldValue" }, "identityCardId": { "type": "string", "format": "uuid", "x-aura-field-code": "identityCardId" }, "identityTypeFieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "identityTypeFieldId" } }, "x-aura-field-code": "identityCardDetails" } }, "identityTypeId": { "type": "string", "format": "uuid", "x-aura-field-code": "identityTypeId" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "identityCardDetails": { "type": "array", "items": { "type": "object", "properties": { "fieldValue": { "type": "string", "x-aura-field-code": "fieldValue" }, "identityCardId": { "type": "string", "format": "uuid", "x-aura-field-code": "identityCardId" }, "identityTypeFieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "identityTypeFieldId" } }, "x-aura-field-code": "identityCardDetails" } }, "identityTypeId": { "type": "string", "format": "uuid", "x-aura-field-code": "identityTypeId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "identityCardDetails": { "type": "array", "items": { "type": "object", "properties": { "fieldValue": { "type": "string", "x-aura-field-code": "fieldValue" }, "identityCardId": { "type": "string", "format": "uuid", "x-aura-field-code": "identityCardId" }, "identityTypeFieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "identityTypeFieldId" } }, "x-aura-field-code": "identityCardDetails" } }, "identityTypeId": { "type": "string", "format": "uuid", "x-aura-field-code": "identityTypeId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-identity-card-by-customer-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customers/{id}/identity-cards", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/customers/{id}/nationalities": { "get": { "operationId": "aurax-bff-redirect-get-nationality-by-customer-id", "tags": [ "customers" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-nationality-by-customer-id", "description": "Request and response fields are declared on the routing target `get-nationality-by-customer-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "countryId": { "type": "integer", "format": "int32", "x-aura-field-code": "countryId" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "priority": { "type": "integer", "format": "int32", "x-aura-field-code": "priority" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "countryId": { "type": "integer", "format": "int32", "x-aura-field-code": "countryId" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "priority": { "type": "integer", "format": "int32", "x-aura-field-code": "priority" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "countryId": { "type": "integer", "format": "int32", "x-aura-field-code": "countryId" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "priority": { "type": "integer", "format": "int32", "x-aura-field-code": "priority" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-nationality-by-customer-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customers/{id}/nationalities", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/customers/{id}/occupations": { "get": { "operationId": "aurax-bff-redirect-get-occupation-list-by-customer-id", "tags": [ "customers" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-occupation-list-by-customer-id", "description": "Request and response fields are declared on the routing target `get-occupation-list-by-customer-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "x-aura-type": "unresolved" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "fieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "fieldId" }, "fieldValue": { "type": "string", "x-aura-field-code": "fieldValue" }, "typeId": { "type": "string", "format": "uuid", "x-aura-field-code": "typeId" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "fieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "fieldId" }, "fieldValue": { "type": "string", "x-aura-field-code": "fieldValue" }, "typeId": { "type": "string", "format": "uuid", "x-aura-field-code": "typeId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "fieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "fieldId" }, "fieldValue": { "type": "string", "x-aura-field-code": "fieldValue" }, "typeId": { "type": "string", "format": "uuid", "x-aura-field-code": "typeId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-occupation-list-by-customer-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customers/{id}/occupations", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/customers/{id}/phones": { "get": { "operationId": "aurax-bff-redirect-get-customer-phone-list-by-customer-id", "tags": [ "customers" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-customer-phone-list-by-customer-id", "description": "Request and response fields are declared on the routing target `get-customer-phone-list-by-customer-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "x-aura-type": "unresolved" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "id": { "x-aura-type": "unresolved" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "isVerified": { "type": "boolean", "x-aura-field-code": "isVerified" }, "phoneNumber": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true }, "phoneType": { "type": "integer", "format": "int32", "x-aura-field-code": "phoneType" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "id": { "x-aura-type": "unresolved" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "isVerified": { "type": "boolean", "x-aura-field-code": "isVerified" }, "phoneNumber": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true }, "phoneType": { "type": "integer", "format": "int32", "x-aura-field-code": "phoneType" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "id": { "x-aura-type": "unresolved" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "isVerified": { "type": "boolean", "x-aura-field-code": "isVerified" }, "phoneNumber": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true }, "phoneType": { "type": "integer", "format": "int32", "x-aura-field-code": "phoneType" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-customer-phone-list-by-customer-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customers/{id}/phones", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/customers/{id}/profiles": { "get": { "operationId": "aurax-bff-redirect-get-customer-profile-list-by-customer-id", "tags": [ "customers" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-customer-profile-list-by-customer-id", "description": "Request and response fields are declared on the routing target `get-customer-profile-list-by-customer-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "x-aura-type": "unresolved" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "id": { "x-aura-type": "unresolved" }, "profile": { "type": "integer", "format": "int32", "x-aura-field-code": "profile" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "id": { "x-aura-type": "unresolved" }, "profile": { "type": "integer", "format": "int32", "x-aura-field-code": "profile" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "id": { "x-aura-type": "unresolved" }, "profile": { "type": "integer", "format": "int32", "x-aura-field-code": "profile" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-customer-profile-list-by-customer-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customers/{id}/profiles", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/customers/{id}/relationships/shareholders": { "get": { "operationId": "aurax-bff-redirect-get-customer-shareholder-by-customer-id", "tags": [ "customers" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-customer-shareholder-by-customer-id", "description": "Request and response fields are declared on the routing target `get-customer-shareholder-by-customer-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "customerRelationshipId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerRelationshipId" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "shareRate": { "type": "number", "format": "decimal", "x-aura-field-code": "shareRate" }, "startDate": { "type": "string", "format": "date-time", "x-aura-field-code": "startDate" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "customerRelationshipId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerRelationshipId" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "shareRate": { "type": "number", "format": "decimal", "x-aura-field-code": "shareRate" }, "startDate": { "type": "string", "format": "date-time", "x-aura-field-code": "startDate" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "customerRelationshipId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerRelationshipId" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "shareRate": { "type": "number", "format": "decimal", "x-aura-field-code": "shareRate" }, "startDate": { "type": "string", "format": "date-time", "x-aura-field-code": "startDate" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-customer-shareholder-by-customer-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customers/{id}/relationships/shareholders", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/customers/{id}/representative-assignments": { "get": { "operationId": "aurax-bff-redirect-get-customer-representative-assignment-list", "tags": [ "customers" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-customer-representative-assignment-list", "description": "Request and response fields are declared on the routing target `get-customer-representative-assignment-list`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" } }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "customerVisitMemos": { "type": "object", "properties": { "customerRepresentativeAssignmentId": { "x-aura-type": "unresolved" }, "id": { "x-aura-type": "unresolved" }, "memoDate": { "x-aura-type": "unresolved" }, "noteText": { "x-aura-type": "unresolved" }, "representativeUserId": { "x-aura-type": "unresolved" } }, "x-aura-type": "unresolved" }, "endDate": { "type": "string", "format": "date-time", "x-aura-field-code": "startDate" }, "id": { "x-aura-type": "unresolved" }, "organizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "organizationId" }, "representativeUserId": { "x-aura-type": "unresolved" }, "startDate": { "type": "string", "format": "date-time", "x-aura-field-code": "startDate" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "customerVisitMemos": { "type": "object", "properties": { "customerRepresentativeAssignmentId": { "x-aura-type": "unresolved" }, "id": { "x-aura-type": "unresolved" }, "memoDate": { "x-aura-type": "unresolved" }, "noteText": { "x-aura-type": "unresolved" }, "representativeUserId": { "x-aura-type": "unresolved" } }, "x-aura-type": "unresolved" }, "endDate": { "type": "string", "format": "date-time", "x-aura-field-code": "startDate" }, "id": { "x-aura-type": "unresolved" }, "organizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "organizationId" }, "representativeUserId": { "x-aura-type": "unresolved" }, "startDate": { "type": "string", "format": "date-time", "x-aura-field-code": "startDate" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "customerVisitMemos": { "type": "object", "properties": { "customerRepresentativeAssignmentId": { "x-aura-type": "unresolved" }, "id": { "x-aura-type": "unresolved" }, "memoDate": { "x-aura-type": "unresolved" }, "noteText": { "x-aura-type": "unresolved" }, "representativeUserId": { "x-aura-type": "unresolved" } }, "x-aura-type": "unresolved" }, "endDate": { "type": "string", "format": "date-time", "x-aura-field-code": "startDate" }, "id": { "x-aura-type": "unresolved" }, "organizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "organizationId" }, "representativeUserId": { "x-aura-type": "unresolved" }, "startDate": { "type": "string", "format": "date-time", "x-aura-field-code": "startDate" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-customer-representative-assignment-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customers/{id}/representative-assignments", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-customer-representative-assignment-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/customers/{id}/residentials": { "get": { "operationId": "aurax-bff-redirect-get-residential-list-by-customer-id", "tags": [ "customers" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-residential-list-by-customer-id", "description": "Request and response fields are declared on the routing target `get-residential-list-by-customer-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "x-aura-type": "unresolved" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "countryId": { "type": "integer", "format": "int32", "x-aura-field-code": "countryId" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "id": { "x-aura-type": "unresolved" }, "priority": { "type": "integer", "format": "int32", "x-aura-field-code": "priority" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "countryId": { "type": "integer", "format": "int32", "x-aura-field-code": "countryId" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "id": { "x-aura-type": "unresolved" }, "priority": { "type": "integer", "format": "int32", "x-aura-field-code": "priority" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "countryId": { "type": "integer", "format": "int32", "x-aura-field-code": "countryId" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "id": { "x-aura-type": "unresolved" }, "priority": { "type": "integer", "format": "int32", "x-aura-field-code": "priority" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-residential-list-by-customer-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customers/{id}/residentials", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/customers/{id}/taxpayers": { "get": { "operationId": "aurax-bff-redirect-get-customer-tax-payer-list-by-customer-id", "tags": [ "customers" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-customer-tax-payer-list-by-customer-id", "description": "Request and response fields are declared on the routing target `get-customer-tax-payer-list-by-customer-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "x-aura-type": "unresolved" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "companyType": { "x-aura-type": "unresolved" }, "countryId": { "type": "integer", "format": "int32", "x-aura-field-code": "countryId" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "description": { "x-aura-type": "unresolved" }, "fatcaReason": { "x-aura-type": "unresolved" }, "id": { "x-aura-type": "unresolved" }, "taxNumber": { "type": "string", "x-aura-field-code": "taxNumber" }, "taxNumberNotReason": { "x-aura-type": "unresolved" }, "taxpayerClass": { "x-aura-type": "unresolved" }, "taxpayerPersonType": { "x-aura-type": "unresolved" }, "taxpayerType": { "type": "integer", "format": "int32", "x-aura-field-code": "taxpayerType" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "companyType": { "x-aura-type": "unresolved" }, "countryId": { "type": "integer", "format": "int32", "x-aura-field-code": "countryId" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "description": { "x-aura-type": "unresolved" }, "fatcaReason": { "x-aura-type": "unresolved" }, "id": { "x-aura-type": "unresolved" }, "taxNumber": { "type": "string", "x-aura-field-code": "taxNumber" }, "taxNumberNotReason": { "x-aura-type": "unresolved" }, "taxpayerClass": { "x-aura-type": "unresolved" }, "taxpayerPersonType": { "x-aura-type": "unresolved" }, "taxpayerType": { "type": "integer", "format": "int32", "x-aura-field-code": "taxpayerType" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "companyType": { "x-aura-type": "unresolved" }, "countryId": { "type": "integer", "format": "int32", "x-aura-field-code": "countryId" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "description": { "x-aura-type": "unresolved" }, "fatcaReason": { "x-aura-type": "unresolved" }, "id": { "x-aura-type": "unresolved" }, "taxNumber": { "type": "string", "x-aura-field-code": "taxNumber" }, "taxNumberNotReason": { "x-aura-type": "unresolved" }, "taxpayerClass": { "x-aura-type": "unresolved" }, "taxpayerPersonType": { "x-aura-type": "unresolved" }, "taxpayerType": { "type": "integer", "format": "int32", "x-aura-field-code": "taxpayerType" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-customer-tax-payer-list-by-customer-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "customers/{id}/taxpayers", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/data-securities/encrypt": { "post": { "operationId": "aurax-bff-data-encrypt", "tags": [ "data-securities" ], "summary": "aurax-bff-data-encrypt", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "string", "x-aura-field-code": "data" } }, "required": [ "data" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-data-encrypt", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "data-securities/encrypt", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Data", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "EncryptionResponse", "payload": "EncryptionResponse", "collection": false, "members": [ { "name": "EncryptedData", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/decision-definitions": { "get": { "operationId": "aurax-bff-redirect-get-decision-definition-list", "tags": [ "decision-definitions" ], "summary": "aurax-bff-redirect-get-decision-definition-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-decision-definition-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "decision-definitions", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "DecisionDefinitionDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "DecisionId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DecisionKey", "declared_type": "long?", "nullable": true, "collection": false }, { "name": "DecisionName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LatestVersionNo", "declared_type": "int", "nullable": false, "collection": false }, { "name": "DeploymentTime", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "XmlResource", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-decision-definition-list", "target_dapr_app_id": "bpm-service", "target_route": "decision-definitions", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/decision-definitions/{id}": { "get": { "operationId": "aurax-bff-redirect-get-decision-definition-by-id", "tags": [ "decision-definitions" ], "summary": "aurax-bff-redirect-get-decision-definition-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-decision-definition-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "decision-definitions/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "DecisionDefinitionByIdDto", "payload": "DecisionDefinitionByIdDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "DecisionId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DecisionKey", "declared_type": "long?", "nullable": true, "collection": false }, { "name": "DecisionName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "XmlResource", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LatestVersionNo", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "DeploymentTime", "declared_type": "DateTime", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-decision-definition-by-id", "target_dapr_app_id": "bpm-service", "target_route": "decision-definitions/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_BPM_39", "status": 400, "message": { "ar": "تعريف القرار غير موجود", "en": "Decision definition is not found", "tr": "Karar tanımı bulunamadı" }, "message_available": true, "constant_name": "DECISION_DEFINITION_IS_NOT_FOUND" } ] } } }, "/decision-definitions/{id}/details": { "get": { "operationId": "aurax-bff-redirect-get-decision-definition-detail-list", "tags": [ "decision-definitions" ], "summary": "aurax-bff-redirect-get-decision-definition-detail-list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-decision-definition-detail-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "decision-definitions/{id}/details", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "DecisionDefinitionDetailDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "DecisionId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DecisionKey", "declared_type": "long?", "nullable": true, "collection": false }, { "name": "DecisionName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "VersionNo", "declared_type": "int", "nullable": false, "collection": false }, { "name": "DeploymentTime", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "XmlResource", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DecisionRequirementId", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-decision-definition-detail-list", "target_dapr_app_id": "bpm-service", "target_route": "decision-definitions/{id}/details", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_BPM_39", "status": 400, "message": { "ar": "تعريف القرار غير موجود", "en": "Decision definition is not found", "tr": "Karar tanımı bulunamadı" }, "message_available": true, "constant_name": "DECISION_DEFINITION_IS_NOT_FOUND" } ] } } }, "/decision-evaluations": { "get": { "operationId": "aurax-bff-redirect-get-decision-evaluation-list", "tags": [ "decision-evaluations" ], "summary": "aurax-bff-redirect-get-decision-evaluation-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-decision-evaluation-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "decision-evaluations", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "DecisionId", "declared_type": null, "nullable": false, "collection": false }, { "name": "DecisionName", "declared_type": null, "nullable": false, "collection": false }, { "name": "VersionNo", "declared_type": null, "nullable": true, "collection": false }, { "name": "DecisionStatus", "declared_type": null, "nullable": true, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "DecisionEvaluationDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "EvaluationDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "DecisionId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DecisionName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "VersionNo", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "DecisionKey", "declared_type": "long", "nullable": false, "collection": false }, { "name": "DecisionOutput", "declared_type": "object", "nullable": false, "collection": false }, { "name": "ProcessDefinitionKey", "declared_type": "long", "nullable": false, "collection": false }, { "name": "ProcessInstanceKey", "declared_type": "long?", "nullable": true, "collection": false }, { "name": "ElementInstanceKey", "declared_type": "long", "nullable": false, "collection": false }, { "name": "EvaluationFailureMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FailedDecisionId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DecisionStatus", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "XmlResource", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-decision-evaluation-list", "target_dapr_app_id": "bpm-service", "target_route": "decision-evaluations", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/decision-evaluations/{id}": { "get": { "operationId": "aurax-bff-redirect-get-decision-evaluation-by-decision-id", "tags": [ "decision-evaluations" ], "summary": "aurax-bff-redirect-get-decision-evaluation-by-decision-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-decision-evaluation-by-decision-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "decision-evaluations/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "DecisionEvaluationDto", "payload": "DecisionEvaluationDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "EvaluationDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "DecisionId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DecisionName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "VersionNo", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "DecisionKey", "declared_type": "long", "nullable": false, "collection": false }, { "name": "DecisionOutput", "declared_type": "object", "nullable": false, "collection": false }, { "name": "ProcessDefinitionKey", "declared_type": "long", "nullable": false, "collection": false }, { "name": "ProcessInstanceKey", "declared_type": "long?", "nullable": true, "collection": false }, { "name": "ElementInstanceKey", "declared_type": "long", "nullable": false, "collection": false }, { "name": "EvaluationFailureMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FailedDecisionId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DecisionStatus", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "XmlResource", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-decision-evaluation-by-decision-id", "target_dapr_app_id": "bpm-service", "target_route": "decision-evaluations/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_BPM_46", "status": 400, "message": { "ar": "لم يتم العثور على معرف تقييم القرار.", "en": "Decision evaluation cannot be found.", "tr": "Karar değerlendirme kimliği bulunamadı." }, "message_available": true, "constant_name": "DECISION_EVALUATION_IS_NOT_FOUND" } ] } } }, "/decision-evaluations/{id}/inputs": { "get": { "operationId": "aurax-bff-redirect-get-decision-evaluation-input-list", "tags": [ "decision-evaluations" ], "summary": "aurax-bff-redirect-get-decision-evaluation-input-list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-decision-evaluation-input-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "decision-evaluations/{id}/inputs", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "DecisionEvaluationInputDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "InputId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InputName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InputValue", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-decision-evaluation-input-list", "target_dapr_app_id": "bpm-service", "target_route": "decision-evaluations/{id}/inputs", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/decision-evaluations/{id}/outputs": { "get": { "operationId": "aurax-bff-redirect-get-decision-evaluation-output-list", "tags": [ "decision-evaluations" ], "summary": "aurax-bff-redirect-get-decision-evaluation-output-list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-decision-evaluation-output-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "decision-evaluations/{id}/outputs", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "DecisionEvaluationOutputDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "RuleId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RuleIndex", "declared_type": "int", "nullable": false, "collection": false }, { "name": "OutputId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OutputName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OutputValue", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-decision-evaluation-output-list", "target_dapr_app_id": "bpm-service", "target_route": "decision-evaluations/{id}/outputs", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/delete-customer-follow-dept-for-unfollowed-loans-bpmn": { "post": { "operationId": "aurax-bff-delete-customer-follow-dept-for-unfollowed-loans-bpmn", "tags": [ "delete-customer-follow-dept-for-unfollowed-loans-bpmn" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-delete-customer-follow-dept-for-unfollowed-loans-bpmn", "description": "Request and response fields are declared on the routing target `delete-customer-follow-dept-for-unfollowed-loans-bpmn`; this entry declares none of its own.", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-delete-customer-follow-dept-for-unfollowed-loans-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "delete-customer-follow-dept-for-unfollowed-loans-bpmn", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/delete-denomination-bpmn": { "post": { "operationId": "aurax-bff-redirect-delete-denomination-bpmn", "tags": [ "delete-denomination-bpmn" ], "summary": "aurax-bff-redirect-delete-denomination-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-denomination-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "delete-denomination-bpmn", "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/denomination-serial-number": { "get": { "operationId": "aurax-bff-redirect-get-denomination-serial-number-list", "tags": [ "denomination-serial-number" ], "summary": "aurax-bff-redirect-get-denomination-serial-number-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. It returns a page of records under `data`, with `total` carrying the unpaged count — but the record's fields are not declared.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-denomination-serial-number-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "denomination-serial-number", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "post": { "operationId": "aurax-bff-redirect-create-denomination-serial-number", "tags": [ "denomination-serial-number" ], "summary": "aurax-bff-redirect-create-denomination-serial-number", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-denomination-serial-number", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "denomination-serial-number", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/denomination-serial-number/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-denomination-serial-number", "tags": [ "denomination-serial-number" ], "summary": "aurax-bff-redirect-delete-denomination-serial-number", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-denomination-serial-number", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "denomination-serial-number/{id}", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "get": { "operationId": "aurax-bff-redirect-get-denomination-serial-number-by-id", "tags": [ "denomination-serial-number" ], "summary": "aurax-bff-redirect-get-denomination-serial-number-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-denomination-serial-number-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "denomination-serial-number/{id}", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "put": { "operationId": "aurax-bff-redirect-update-denomination-serial-number", "tags": [ "denomination-serial-number" ], "summary": "aurax-bff-redirect-update-denomination-serial-number", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-denomination-serial-number", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "denomination-serial-number/{id}", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/denomination-transactions": { "get": { "operationId": "aurax-bff-redirect-get-denomination-transaction-list", "tags": [ "denomination-transactions" ], "summary": "aurax-bff-redirect-get-denomination-transaction-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. It returns a page of records under `data`, with `total` carrying the unpaged count — but the record's fields are not declared.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-denomination-transaction-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "denomination-transactions", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "post": { "operationId": "aurax-bff-redirect-create-denomination-transaction", "tags": [ "denomination-transactions" ], "summary": "aurax-bff-redirect-create-denomination-transaction", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-denomination-transaction", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "denomination-transactions", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/denomination-transactions/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-denomination-transaction", "tags": [ "denomination-transactions" ], "summary": "aurax-bff-redirect-delete-denomination-transaction", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-denomination-transaction", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "denomination-transactions/{id}", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "get": { "operationId": "aurax-bff-redirect-get-denomination-transaction-by-id", "tags": [ "denomination-transactions" ], "summary": "aurax-bff-redirect-get-denomination-transaction-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-denomination-transaction-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "denomination-transactions/{id}", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "put": { "operationId": "aurax-bff-redirect-update-denomination-transaction", "tags": [ "denomination-transactions" ], "summary": "aurax-bff-redirect-update-denomination-transaction", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-denomination-transaction", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "denomination-transactions/{id}", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/denominations": { "get": { "operationId": "aurax-bff-dynamic-get-denomination-list", "tags": [ "denominations" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-denomination-list", "description": "Request and response fields are declared on the routing target `get-denomination-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "denominationId" }, "name": { "type": "string", "x-aura-field-code": "denominationName" }, "type": { "type": "integer", "format": "int32", "x-aura-field-code": "denominationType" }, "unit": { "type": "number", "format": "decimal", "x-aura-field-code": "denominationUnit" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-denomination-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "denominations", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-denomination-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "DenominationDto", "collection": true, "members": [ { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Type", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Unit", "declared_type": "decimal?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-denomination-list", "target_dapr_app_id": "account-service", "target_route": "denominations", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-dynamic-create-denomination", "tags": [ "denominations" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-create-denomination", "description": "Request and response fields are declared on the routing target `create-denomination-bpmn`; this entry declares none of its own.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "name": { "type": "string", "x-aura-field-code": "denominationName" }, "type": { "type": "integer", "format": "int32", "x-aura-field-code": "denominationType" }, "unit": { "type": "number", "format": "decimal", "x-aura-field-code": "denominationUnit" } } } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 4, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "denominationId" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "denominationId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "denominationId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-create-denomination", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "denominations", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/denominations/{id}": { "delete": { "operationId": "aurax-bff-dynamic-delete-denomination", "tags": [ "denominations" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-delete-denomination", "description": "Request and response fields are declared on the routing target `delete-denomination-bpmn`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in this route template but not among the Route-bound fields of the routing target `delete-denomination-bpmn`, whose own path is decoupled from this one.", "x-aura-source": "route-template-only-after-collapse" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "denominationId" } } } } }, "description": "The catalog declares Body-bound fields on this DELETE operation. Request bodies on DELETE have no defined semantics in HTTP; this documents the catalog, not a recommendation. Not every field below is accepted: the platform selects which of them this operation admits and drops the rest.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [ "body" ], "dropped_field_names": { "body": [ "id" ] }, "dropped_mandatory_field_names": [], "verdict": "declared-fields-not-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": "The HTTP edge in front of this operation comes in two shapes and they differ: the platform's typed route readers bind GET and DELETE from the URL and never read a body, while its untyped catalog-redirect reader collects the body whenever the request carries one. It does not change the answer above: the selection below happens after the edge, and excludes these fields either way." }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-delete-denomination", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "denominations/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "get": { "operationId": "aurax-bff-dynamic-get-denomination-by-id", "tags": [ "denominations" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-denomination-by-id", "description": "Request and response fields are declared on the routing target `get-denomination-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "denominationId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "denominationId" }, "name": { "type": "string", "x-aura-field-code": "denominationName" }, "type": { "type": "integer", "format": "int32", "x-aura-field-code": "denominationType" }, "unit": { "type": "number", "format": "decimal", "x-aura-field-code": "denominationUnit" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-denomination-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "denominations/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "DenominationDto", "payload": "DenominationDto", "collection": false, "members": [ { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Type", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Unit", "declared_type": "decimal?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-denomination-by-id", "target_dapr_app_id": "account-service", "target_route": "denominations/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCNT_121", "status": 400, "message": { "ar": "لم يتم العثور على الطائفة بالمعرف المُعطى '{0}'.", "en": "Denomination is not found with the given id'{0}'.", "tr": "Kupüre ait verilen kimlikle bulunamadı: '{0}'" }, "message_available": true, "constant_name": "DENOMINATION_IS_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-dynamic-update-denomination", "tags": [ "denominations" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-update-denomination", "description": "Request and response fields are declared on the routing target `update-denomination-bpmn`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in this route template but not among the Route-bound fields of the routing target `update-denomination-bpmn`, whose own path is decoupled from this one.", "x-aura-source": "route-template-only-after-collapse" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "denominationId" }, "name": { "type": "string", "x-aura-field-code": "denominationName" }, "type": { "type": "integer", "format": "int32", "x-aura-field-code": "denominationType" }, "unit": { "type": "number", "format": "decimal", "x-aura-field-code": "denominationUnit" } } } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 5, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-update-denomination", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "denominations/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/distraint-collection": { "post": { "operationId": "aurax-bff-redirect-distraint-collection-bpmn", "tags": [ "distraint-collection" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-distraint-collection-bpmn", "description": "Request and response fields are declared on the routing target `distraint-collection-bpmn`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "collectionAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "collectionAmount" }, "description": { "type": "string", "x-aura-field-code": "description" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } }, "required": [ "collectionAmount", "id" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 3, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-distraint-collection-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "distraint-collection", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/distraint-file-accounts": { "get": { "operationId": "aurax-bff-dynamic-get-distraint-file-account-list", "tags": [ "distraint-file-accounts" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-distraint-file-account-list", "description": "Request and response fields are declared on the routing target `get-distraint-file-account-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a collection.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-distraint-file-account-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "distraint-file-accounts", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-distraint-file-account-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "DistraintFileAccountDto", "collection": true, "members": [ { "name": "OutgoingDistraintFileDetailId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "IncomingDistraintFileDetailId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Iban", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AccountId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CustomerBlockedId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Amount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CurrencyId", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "DistraintTransactionType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "OrganizationId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "AccountTypeCode", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/distraint-file-accounts/{id}": { "get": { "operationId": "aurax-bff-dynamic-get-distraint-file-account-by-id", "tags": [ "distraint-file-accounts" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-distraint-file-account-by-id", "description": "Request and response fields are declared on the routing target `get-distraint-file-account-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-distraint-file-account-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "distraint-file-accounts/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "DistraintFileAccountDto", "payload": "DistraintFileAccountDto", "collection": false, "members": [ { "name": "OutgoingDistraintFileDetailId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "IncomingDistraintFileDetailId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Iban", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AccountId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CustomerBlockedId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Amount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CurrencyId", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "DistraintTransactionType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "OrganizationId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "AccountTypeCode", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCNT_169", "status": 400, "message": null, "message_available": false, "constant_name": "DISTRAINT_FILE_ACCOUNT_NOT_FOUND" } ] } } }, "/distraint-process-reports": { "get": { "operationId": "aurax-bff-dynamic-get-distraint-process-report-list", "tags": [ "distraint-process-reports" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-distraint-process-report-list", "description": "Request and response fields are declared on the routing target `get-distraint-process-report-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a collection.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-distraint-process-report-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "distraint-process-reports", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-distraint-process-report-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "DistraintProcessReportDto", "collection": true, "members": [ { "name": "OutgoingDistraintFileId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "TaxNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TaxOfficeCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DistraintNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ResponsePackageCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DistraintAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "RecordState", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ErrorDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReportType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Details", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/distraint-process-reports/{id}": { "get": { "operationId": "aurax-bff-dynamic-get-distraint-process-report-by-id", "tags": [ "distraint-process-reports" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-distraint-process-report-by-id", "description": "Request and response fields are declared on the routing target `get-distraint-process-report-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-distraint-process-report-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "distraint-process-reports/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "DistraintProcessReportDto", "payload": "DistraintProcessReportDto", "collection": false, "members": [ { "name": "OutgoingDistraintFileId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "TaxNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TaxOfficeCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DistraintNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ResponsePackageCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DistraintAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "RecordState", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ErrorDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReportType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Details", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCNT_171", "status": 400, "message": null, "message_available": false, "constant_name": "DISTRAINT_PROCESS_REPORT_NOT_FOUND" } ] } } }, "/distraint-process-reports/{id}/details": { "get": { "operationId": "aurax-bff-dynamic-get-distraint-process-report-detail-list", "tags": [ "distraint-process-reports" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-distraint-process-report-detail-list", "description": "Request and response fields are declared on the routing target `get-distraint-process-report-detail-list`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a collection.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-distraint-process-report-detail-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "distraint-process-reports/{id}/details", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-distraint-process-report-detail-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "DistraintProcessReportDetailDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "DistraintFileAccountId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "AccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Balance", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "AvailableBalanceBefore", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "AvailableBalanceAfter", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "WithholdingBefore", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "WithholdingAfter", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "Risk", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "BankRisk", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "WithholdingAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "ReserveAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "FxRate", "declared_type": "decimal?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/dms-map-items": { "get": { "operationId": "aurax-bff-redirect-get-document-service-map-item-list", "tags": [ "dms-map-items" ], "summary": "aurax-bff-redirect-get-document-service-map-item-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-document-service-map-item-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "dms-map-items", "x-aura-code-response": { "state": "structure", "declared_type": "DocumentServiceMapItemDto", "payload": "DocumentServiceMapItemDto", "collection": false, "members": [ { "name": "Items", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-document-service-map-item-list", "target_dapr_app_id": "document-management-service", "target_route": "document-service-map-items", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_DMS_17", "status": 400, "message": { "ar": "لم يتم العثور على خريطة خدمة المستندات.", "en": "Document service map cannot be found.", "tr": "Belge servisi eşleşmesi bulunamadı." }, "message_available": true, "constant_name": "DOCUMENT_SERVICE_MAP_NOT_FOUND" } ] } } }, "/dms-models": { "get": { "operationId": "aurax-bff-redirect-get-dms-model-list", "tags": [ "dms-models" ], "summary": "aurax-bff-redirect-get-dms-model-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-dms-model-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "dms-models", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "DmsModelDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CmisProvider", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "DmsModelItems", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-dms-model-list", "target_dapr_app_id": "document-management-service", "target_route": "dms-models", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-dms-model-ui-bpm", "tags": [ "dms-models" ], "summary": "aurax-bff-redirect-create-dms-model-ui-bpm", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-dms-model-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "dms-models", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CmisProvider", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/dms-models/items": { "get": { "operationId": "aurax-bff-redirect-get-dms-model-item-list", "tags": [ "dms-models" ], "summary": "aurax-bff-redirect-get-dms-model-item-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-dms-model-item-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "dms-models/items", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "DmsModelItemDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "DmsModelId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CmisType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ItemName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ParentDmsModelItemId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "DataType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "IsMandatory", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-dms-model-item-list", "target_dapr_app_id": "document-management-service", "target_route": "dms-models/items", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/dms-models/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-dms-model-bpm", "tags": [ "dms-models" ], "summary": "aurax-bff-redirect-delete-dms-model-bpm", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-dms-model-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "dms-models/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "get": { "operationId": "aurax-bff-redirect-get-dms-model-by-id", "tags": [ "dms-models" ], "summary": "aurax-bff-redirect-get-dms-model-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-dms-model-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "dms-models/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "DmsModelDto", "payload": "DmsModelDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CmisProvider", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "DmsModelItems", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-dms-model-by-id", "target_dapr_app_id": "document-management-service", "target_route": "dms-models/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_DMS_22", "status": 400, "message": { "ar": "لم يتم العثور على نموذج DMS.", "en": "DMS Model cannot be found.", "tr": "DMS Modeli bulunamadı." }, "message_available": true, "constant_name": "DMS_MODEL_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-dms-model-ui-bpm", "tags": [ "dms-models" ], "summary": "aurax-bff-redirect-update-dms-model-ui-bpm", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-dms-model-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "dms-models/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/dms-models/{id}/items": { "get": { "operationId": "aurax-bff-redirect-get-dms-model-item-list-by-id", "tags": [ "dms-models" ], "summary": "aurax-bff-redirect-get-dms-model-item-list-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-dms-model-item-list-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "dms-models/{id}/items", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "DmsModelItemDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "DmsModelId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CmisType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ItemName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ParentDmsModelItemId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "DataType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "IsMandatory", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-dms-model-item-list-by-id", "target_dapr_app_id": "document-management-service", "target_route": "dms-models/{id}/items", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_DMS_22", "status": 400, "message": { "ar": "لم يتم العثور على نموذج DMS.", "en": "DMS Model cannot be found.", "tr": "DMS Modeli bulunamadı." }, "message_available": true, "constant_name": "DMS_MODEL_NOT_FOUND" } ] } } }, "/dms-queries": { "get": { "operationId": "aurax-bff-redirect-get-dms-query-list", "tags": [ "dms-queries" ], "summary": "aurax-bff-redirect-get-dms-query-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-dms-query-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "dms-queries", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "DmsQueryDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SelectedItems", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-dms-query-list", "target_dapr_app_id": "document-management-service", "target_route": "dms-queries", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-dms-query", "tags": [ "dms-queries" ], "summary": "aurax-bff-redirect-create-dms-query", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-dms-query", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "dms-queries", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "SelectedItems", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/dms-queries/model-maps": { "get": { "operationId": "aurax-bff-redirect-get-dms-query-model-map-list", "tags": [ "dms-queries" ], "summary": "aurax-bff-redirect-get-dms-query-model-map-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-dms-query-model-map-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "dms-queries/model-maps", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "DmsQueryModelMapDto", "collection": true, "members": [ { "name": "DmsQueryId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "DmsModelItemId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "WhereStatement", "declared_type": "int", "nullable": false, "collection": false }, { "name": "IsMandatory", "declared_type": "bool?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-dms-query-model-map-list", "target_dapr_app_id": "document-management-service", "target_route": "dms-queries/model-maps", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/dms-queries/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-dms-query", "tags": [ "dms-queries" ], "summary": "aurax-bff-redirect-delete-dms-query", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-dms-query", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "dms-queries/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "get": { "operationId": "aurax-bff-redirect-get-dms-query-by-id", "tags": [ "dms-queries" ], "summary": "aurax-bff-redirect-get-dms-query-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-dms-query-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "dms-queries/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "DmsQueryDto", "payload": "DmsQueryDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SelectedItems", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-dms-query-by-id", "target_dapr_app_id": "document-management-service", "target_route": "dms-queries/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_DMS_24", "status": 400, "message": { "ar": "لم يتم العثور على الاستعلام الأساسي.", "en": "Base query cannot be found.", "tr": "Temel sorgu bulunamadı." }, "message_available": true, "constant_name": "BASE_QUERY_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-dms-query", "tags": [ "dms-queries" ], "summary": "aurax-bff-redirect-update-dms-query", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-dms-query", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "dms-queries/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "SelectedItems", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/dms-queries/{id}/model-maps": { "post": { "operationId": "aurax-bff-redirect-create-dms-query-model-map-bpm", "tags": [ "dms-queries" ], "summary": "aurax-bff-redirect-create-dms-query-model-map-bpm", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-dms-query-model-map-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "dms-queries/{id}/model-maps", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "DmsModelId", "declared_type": null, "nullable": false, "collection": false }, { "name": "DmsModelItemId", "declared_type": null, "nullable": false, "collection": false }, { "name": "WhereStatement", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsMandatory", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/dms-queries/{id}/model-maps/{dmsQueryModelMapId}": { "delete": { "operationId": "aurax-bff-redirect-delete-dms-query-model-map-bpm", "tags": [ "dms-queries" ], "summary": "aurax-bff-redirect-delete-dms-query-model-map-bpm", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "dmsQueryModelMapId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-dms-query-model-map-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "dms-queries/{id}/model-maps/{dmsQueryModelMapId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "DmsQueryModelMapId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "get": { "operationId": "aurax-bff-redirect-get-dms-query-model-map-by-id", "tags": [ "dms-queries" ], "summary": "aurax-bff-redirect-get-dms-query-model-map-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "dmsQueryModelMapId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-dms-query-model-map-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "dms-queries/{id}/model-maps/{dmsQueryModelMapId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "DmsQueryModelMapId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "DmsQueryModelMapDto", "payload": "DmsQueryModelMapDto", "collection": false, "members": [ { "name": "DmsQueryId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "DmsModelItemId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "WhereStatement", "declared_type": "int", "nullable": false, "collection": false }, { "name": "IsMandatory", "declared_type": "bool?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-dms-query-model-map-by-id", "target_dapr_app_id": "document-management-service", "target_route": "dms-queries/{id}/model-maps/{dmsQueryModelMapId}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_DMS_24", "status": 400, "message": { "ar": "لم يتم العثور على الاستعلام الأساسي.", "en": "Base query cannot be found.", "tr": "Temel sorgu bulunamadı." }, "message_available": true, "constant_name": "BASE_QUERY_NOT_FOUND" }, { "code": "ERR_DMS_34", "status": 400, "message": { "ar": "لم يتم العثور على خريطة نموذج استعلام DMS.", "en": "DMS Query model map cannot be found.", "tr": "DMS Sorgu modeli eşlemesi bulunamadı." }, "message_available": true, "constant_name": "DMS_QUERY_MODEL_MAP_NOT_FOUND" } ] } } }, "/document-items": { "get": { "operationId": "aurax-bff-redirect-get-document-item-list", "tags": [ "document-items" ], "summary": "aurax-bff-redirect-get-document-item-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-document-item-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "document-items", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "DocumentItemDto", "collection": true, "members": [ { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsUnique", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "TemplateTypeId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "TemplateDesignId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "DocumentItemDetails", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-document-item-list", "target_dapr_app_id": "document-management-service", "target_route": "document-items", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-document-item-create-ui-bpm", "tags": [ "document-items" ], "summary": "aurax-bff-redirect-document-item-create-ui-bpm", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-document-item-create-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "document-items", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Code", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsUnique", "declared_type": null, "nullable": false, "collection": false }, { "name": "TemplateTypeId", "declared_type": null, "nullable": true, "collection": false }, { "name": "TemplateDesignId", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/document-items/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-document-item-bpm", "tags": [ "document-items" ], "summary": "aurax-bff-redirect-delete-document-item-bpm", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-document-item-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "document-items/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "get": { "operationId": "aurax-bff-redirect-get-document-item-by-id", "tags": [ "document-items" ], "summary": "aurax-bff-redirect-get-document-item-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-document-item-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "document-items/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "DocumentItemDto", "payload": "DocumentItemDto", "collection": false, "members": [ { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsUnique", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "TemplateTypeId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "TemplateDesignId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "DocumentItemDetails", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-document-item-by-id", "target_dapr_app_id": "document-management-service", "target_route": "document-items/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_DMS_14", "status": 400, "message": { "ar": "لم يتم العثور على عنصر المستند.", "en": "Document Item cannot be found.", "tr": "Belge Öğesi bulunamadı." }, "message_available": true, "constant_name": "DOCUMENT_ITEM_NOT_FOUND" }, { "code": "ERR_DMS_16", "status": 400, "message": { "ar": "عنصر المستند غير نشط.", "en": "Document item is passive.", "tr": "Belge öğesi pasiftir." }, "message_available": true, "constant_name": "DOCUMENT_ITEM_IS_PASSIVE" } ] } }, "put": { "operationId": "aurax-bff-redirect-document-item-edit-ui-bpm", "tags": [ "document-items" ], "summary": "aurax-bff-redirect-document-item-edit-ui-bpm", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-document-item-edit-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "document-items/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsUnique", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": null, "nullable": false, "collection": false }, { "name": "TemplateTypeId", "declared_type": null, "nullable": true, "collection": false }, { "name": "TemplateDesignId", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/document-service-maps": { "get": { "operationId": "aurax-bff-redirect-get-document-service-map-list", "tags": [ "document-service-maps" ], "summary": "aurax-bff-redirect-get-document-service-map-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-document-service-map-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "document-service-maps", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "DocumentServiceMapDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "DocumentItemId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ProcessElementId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ProcessDefinitionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "FormulaDefinitionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "FormDefinitionId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Necessity", "declared_type": "int", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "TransactionType", "declared_type": "int", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-document-service-map-list", "target_dapr_app_id": "document-management-service", "target_route": "document-service-maps", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-document-service-map-ui-bpm", "tags": [ "document-service-maps" ], "summary": "aurax-bff-redirect-create-document-service-map-ui-bpm", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-document-service-map-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "document-service-maps", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "DocumentItemId", "declared_type": null, "nullable": true, "collection": false }, { "name": "ProcessElementId", "declared_type": null, "nullable": true, "collection": false }, { "name": "ProcessDefinitionId", "declared_type": null, "nullable": true, "collection": false }, { "name": "Necessity", "declared_type": null, "nullable": true, "collection": false }, { "name": "FormulaDefinitionId", "declared_type": null, "nullable": true, "collection": false }, { "name": "FormDefinitionId", "declared_type": null, "nullable": true, "collection": false }, { "name": "TransactionType", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/document-service-maps/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-document-service-map-ui-bpm", "tags": [ "document-service-maps" ], "summary": "aurax-bff-redirect-delete-document-service-map-ui-bpm", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-document-service-map-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "document-service-maps/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "get": { "operationId": "aurax-bff-redirect-get-document-service-map-by-id", "tags": [ "document-service-maps" ], "summary": "aurax-bff-redirect-get-document-service-map-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-document-service-map-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "document-service-maps/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "DocumentServiceMapDto", "payload": "DocumentServiceMapDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "DocumentItemId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ProcessElementId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ProcessDefinitionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "FormulaDefinitionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "FormDefinitionId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Necessity", "declared_type": "int", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "TransactionType", "declared_type": "int", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-document-service-map-by-id", "target_dapr_app_id": "document-management-service", "target_route": "document-service-maps/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_DMS_17", "status": 400, "message": { "ar": "لم يتم العثور على خريطة خدمة المستندات.", "en": "Document service map cannot be found.", "tr": "Belge servisi eşleşmesi bulunamadı." }, "message_available": true, "constant_name": "DOCUMENT_SERVICE_MAP_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-document-service-map-ui-bpm", "tags": [ "document-service-maps" ], "summary": "aurax-bff-redirect-update-document-service-map-ui-bpm", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-document-service-map-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "document-service-maps/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "DocumentItemId", "declared_type": null, "nullable": true, "collection": false }, { "name": "ProcessElementId", "declared_type": null, "nullable": true, "collection": false }, { "name": "ProcessDefinitionId", "declared_type": null, "nullable": true, "collection": false }, { "name": "FormulaDefinitionId", "declared_type": null, "nullable": true, "collection": false }, { "name": "FormDefinitionId", "declared_type": null, "nullable": true, "collection": false }, { "name": "Necessity", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionType", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/documents": { "get": { "operationId": "aurax-bff-redirect-get-document-by-path", "tags": [ "documents" ], "summary": "aurax-bff-redirect-get-document-by-path", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-document-by-path", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "documents", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Path", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "DocumentDto", "payload": "DocumentDto", "collection": false, "members": [ { "name": "FileName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ContentType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FileStream", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-document-by-path", "target_dapr_app_id": "document-management-service", "target_route": "documents", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-create-document-by-path", "tags": [ "documents" ], "summary": "aurax-bff-create-document-by-path", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-create-document-by-path", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "documents", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Action", "declared_type": null, "nullable": false, "collection": false }, { "name": "Path", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "NewName", "declared_type": null, "nullable": false, "collection": false }, { "name": "TargetPath", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ItemUIDto", "payload": "ItemUIDto", "collection": false, "members": [ { "name": "Cwd", "declared_type": "FileDto", "nullable": false, "collection": false }, { "name": "Error", "declared_type": "object", "nullable": false, "collection": false }, { "name": "Details", "declared_type": "object", "nullable": false, "collection": false }, { "name": "Files", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." } } }, "/documents/convert": { "post": { "operationId": "aurax-bff-redirect-convert-document", "tags": [ "documents" ], "summary": "aurax-bff-redirect-convert-document", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-convert-document", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "documents/convert", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "base64DocFile", "declared_type": null, "nullable": false, "collection": false }, { "name": "fileExtension", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "declared-non-dto", "note": "The route returns `string`, a scalar rather than an object. There is no field tree below because there are no fields: the body is a JSON string. This is a complete answer read from the declaration, not a gap.", "declared_type": "string", "payload": "string", "forwarded": { "service_code": "convert-document", "target_dapr_app_id": "document-management-service", "target_route": "documents/convert", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." }, "documentation": { "summary": "The Syncfusion.EJ2.AspNet.Core NuGet package has dependencies, Newtonsoft.Json for JSON serialization and Syncfusion.Licensing for validating Syncfusion license key. https://ej2.syncfusion.com/aspnetcore/documentation/maps/getting-started", "source": "the service's own XML documentation comment, read from its source", "about": "the handler that serves this route" } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_DMS_44", "status": 400, "message": { "ar": "محرر المستندات EJ2 لا يدعم تنسيق الملف هذا. امتداد الملف: {0}", "en": "EJ2 DocumentEditor does not support this file format. File extension: {0}", "tr": "EJ2 Belge Düzenleyicisi bu dosya biçimini desteklemez. Dosya uzantısı: {0}" }, "message_available": true, "constant_name": "EJ2_DOCUMENT_EDITOR_DOES_NOT_SUPPORT_THIS_FILE_FORMAT" } ] } } }, "/documents/download": { "post": { "operationId": "aurax-bff-download-document", "tags": [ "documents" ], "summary": "aurax-bff-download-document", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-download-document", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "documents/download", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "DownloadInput", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "declared-non-dto", "note": "The route's declared response type is `FileStreamResult`, which is not a DTO declaration, so there is no member structure in the code to publish. This is what the code says, not a measurement of what the endpoint answers.", "declared_type": "FileStreamResult", "payload": "FileStreamResult" } } }, "/documents/search-in-folder": { "post": { "operationId": "search-item", "tags": [ "documents" ], "summary": "search-item", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "path": { "type": "string", "x-aura-field-code": "path" }, "term": { "type": "string", "x-aura-field-code": "term" } }, "required": [ "id", "path", "term" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 3, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "search-item", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "documents/search-in-folder", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Path", "declared_type": null, "nullable": false, "collection": false }, { "name": "Term", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ItemUIDto", "payload": "ItemUIDto", "collection": false, "members": [ { "name": "Cwd", "declared_type": "FileDto", "nullable": false, "collection": false }, { "name": "Error", "declared_type": "object", "nullable": false, "collection": false }, { "name": "Details", "declared_type": "object", "nullable": false, "collection": false }, { "name": "Files", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/documents/upload": { "post": { "operationId": "aurax-bff-upload-document", "tags": [ "documents" ], "summary": "aurax-bff-upload-document", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-upload-document", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "documents/upload", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "IsCustomerCreate", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "UploadDocumentDto", "payload": "UploadDocumentDto", "collection": false, "members": [ { "name": "Id", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Errors", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_AURAX_25", "status": 400, "message": null, "message_available": false, "constant_name": "UPLOAD_DOCUMENT_EXCEPTION" }, { "code": "ERR_AURAX_42", "status": 400, "message": null, "message_available": false, "constant_name": "UPLOAD_DOCUMENT_CAN_NOT_BE_NULL" } ] } } }, "/documents/upload-by-path": { "post": { "operationId": "aurax-bff-upload-document-by-path", "tags": [ "documents" ], "summary": "aurax-bff-upload-document-by-path", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-upload-document-by-path", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "documents/upload-by-path", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Action", "declared_type": null, "nullable": false, "collection": false }, { "name": "Path", "declared_type": null, "nullable": false, "collection": false }, { "name": "UploadFiles", "declared_type": null, "nullable": false, "collection": false }, { "name": "FileName", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" } } }, "/documents/{id}": { "get": { "operationId": "aurax-bff-redirect-get-document-by-id", "tags": [ "documents" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-document-by-id", "description": "Request and response fields are declared on the routing target `get-document-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "documentId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "contentType": { "type": "string", "x-aura-field-code": "contentType" }, "fileName": { "type": "string", "x-aura-field-code": "fileName" }, "fileStream": { "type": "string", "x-aura-field-code": "fileStream" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-document-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "documents/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "DocumentDto", "payload": "DocumentDto", "collection": false, "members": [ { "name": "FileName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ContentType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FileStream", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/domain-caches/keys": { "get": { "operationId": "aurax-bff-get-cache-key-list", "tags": [ "domain-caches" ], "summary": "aurax-bff-get-cache-key-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-get-cache-key-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "domain-caches/keys", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "DaprAppId", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "PagedResultDto", "envelopes": [ "PagedResultDto" ], "payload": "CacheKeyDto", "collection": false, "members": [ { "name": "Key", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsSharedBetweenApplications", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "Mode", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/domain-caches/refresh": { "post": { "operationId": "aurax-bff-refresh-cache", "tags": [ "domain-caches" ], "summary": "aurax-bff-refresh-cache", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-refresh-cache", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "domain-caches/refresh", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "DaprAppId", "declared_type": null, "nullable": false, "collection": false }, { "name": "Key", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "RefreshCacheDto", "collection": true, "members": [ { "name": "Key", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsSuccess", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/domain-caches/responses/refresh": { "post": { "operationId": "aurax-bff-refresh-response-cache", "tags": [ "domain-caches" ], "summary": "aurax-bff-refresh-response-cache", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-refresh-response-cache", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "domain-caches/responses/refresh", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "DaprAppId", "declared_type": null, "nullable": false, "collection": false }, { "name": "ServiceCode", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "RefreshResponseCacheDto", "collection": true, "members": [ { "name": "Key", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsSuccess", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/domain-compensating-events": { "get": { "operationId": "aurax-bff-redirect-get-domain-compensating-event-list", "tags": [ "domain-compensating-events" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-domain-compensating-event-list", "description": "Request and response fields are declared on the routing target `get-domain-compensating-event-list`; this entry declares none of its own.", "parameters": [ { "name": "daprAppId", "in": "query", "required": true, "schema": { "type": "string", "x-aura-field-code": "daprAppId" } }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "code" }, "expression": { "type": "string", "x-aura-field-code": "expression" }, "parameters": { "type": "object", "x-aura-field-code": "parameters" } }, "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 6 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a collection.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-domain-compensating-event-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "domain-compensating-events", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-domain-compensating-event-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "DaprAppId", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "CompensatingEventDto", "collection": true, "members": [ { "name": "EventId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CorrelationId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "EventType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "EventPayload", "declared_type": "string", "nullable": false, "collection": false }, { "name": "StateCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CreatedDate", "declared_type": "DateTime", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/domain-compensating-events/{id}": { "get": { "operationId": "aurax-bff-redirect-get-domain-compensating-event-by-id", "tags": [ "domain-compensating-events" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-domain-compensating-event-by-id", "description": "Request and response fields are declared on the routing target `get-domain-compensating-event-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "compensatingEventId" } }, { "name": "daprAppId", "in": "query", "required": true, "schema": { "type": "string", "x-aura-field-code": "daprAppId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 1 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-domain-compensating-event-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "domain-compensating-events/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "DaprAppId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "CompensatingEventDto", "payload": "CompensatingEventDto", "collection": false, "members": [ { "name": "EventId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CorrelationId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "EventType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "EventPayload", "declared_type": "string", "nullable": false, "collection": false }, { "name": "StateCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CreatedDate", "declared_type": "DateTime", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/domain-data-migrations": { "get": { "operationId": "aurax-bff-get-data-migration-list", "tags": [ "domain-data-migrations" ], "summary": "aurax-bff-get-data-migration-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-get-data-migration-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "domain-data-migrations", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "DaprAppId", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "PagedResultDto", "envelopes": [ "PagedResultDto" ], "payload": "DataMigrationDto", "collection": false, "members": [ { "name": "Id", "declared_type": "int", "nullable": false, "collection": false }, { "name": "BranchName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TableName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LastCommittedId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LastCommittedDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "Script", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Parameters", "declared_type": "string", "nullable": false, "collection": false }, { "name": "HasError", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "ErrorMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DatabaseName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CreatedDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "TransactionStatus", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/domain-inbox-events": { "get": { "operationId": "aurax-bff-redirect-get-domain-inbox-event-list", "tags": [ "domain-inbox-events" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-domain-inbox-event-list", "description": "Request and response fields are declared on the routing target `get-domain-inbox-event-list`; this entry declares none of its own.", "parameters": [ { "name": "daprAppId", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "daprAppId" } }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "code" }, "expression": { "type": "string", "x-aura-field-code": "expression" }, "parameters": { "type": "object", "x-aura-field-code": "parameters" } }, "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 6 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a collection.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-domain-inbox-event-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "domain-inbox-events", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-domain-inbox-event-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "DaprAppId", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "InboxEventDto", "collection": true, "members": [ { "name": "EventId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "EventName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "EventTopicName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "EventPayload", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IdempotencyKey", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CorrelationId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "RelatedEventId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "IsProcessed", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "ProcessDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "ResponseCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "HasError", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "ErrorCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ErrorMessage", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/domain-inbox-events/{id}": { "get": { "operationId": "aurax-bff-redirect-get-domain-inbox-event-by-id", "tags": [ "domain-inbox-events" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-domain-inbox-event-by-id", "description": "Request and response fields are declared on the routing target `get-domain-inbox-event-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "inboxEventId" } }, { "name": "daprAppId", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "daprAppId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 1 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-domain-inbox-event-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "domain-inbox-events/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "DaprAppId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "InboxEventDto", "payload": "InboxEventDto", "collection": false, "members": [ { "name": "EventId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "EventName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "EventTopicName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "EventPayload", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IdempotencyKey", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CorrelationId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "RelatedEventId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "IsProcessed", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "ProcessDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "ResponseCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "HasError", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "ErrorCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ErrorMessage", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/domain-inbox-events/{id}/trigger": { "post": { "operationId": "aurax-bff-redirect-trigger-domain-inbox-event", "tags": [ "domain-inbox-events" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-trigger-domain-inbox-event", "description": "Request and response fields are declared on the routing target `trigger-domain-inbox-event`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "inboxEventId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "daprAppId": { "type": "string", "x-aura-field-code": "daprAppId" } }, "required": [ "daprAppId" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-trigger-domain-inbox-event", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "domain-inbox-events/{id}/trigger", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "DaprAppId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" } } }, "/domain-key-formats/reset-counter": { "put": { "operationId": "aurax-bff-redirect-reset-domain-key-format-counter", "tags": [ "domain-key-formats" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-reset-domain-key-format-counter", "description": "Request and response fields are declared on the routing target `reset-domain-key-format-counter`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "keyFormatCode" }, "daprAppId": { "type": "string", "x-aura-field-code": "daprAppId" } }, "required": [ "code", "daprAppId" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 2, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-reset-domain-key-format-counter", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "domain-key-formats/reset-counter", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Code", "declared_type": null, "nullable": false, "collection": false }, { "name": "DaprAppId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" } } }, "/domain-localizations": { "get": { "operationId": "aurax-bff-get-localization-list", "tags": [ "domain-localizations" ], "summary": "aurax-bff-get-localization-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-get-localization-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "domain-localizations", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "DaprAppId", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "LocalizationDto", "collection": true, "members": [ { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Type", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Context", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Translations", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-domain-localization-list", "target_dapr_app_id": "aurax-management-service", "target_route": "domain-localizations", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-create-localization", "tags": [ "domain-localizations" ], "summary": "aurax-bff-create-localization", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-create-localization", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "domain-localizations", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Code", "declared_type": null, "nullable": false, "collection": false }, { "name": "DaprAppId", "declared_type": null, "nullable": false, "collection": false }, { "name": "Type", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/domain-localizations/{id}": { "delete": { "operationId": "aurax-bff-delete-localization", "tags": [ "domain-localizations" ], "summary": "aurax-bff-delete-localization", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-delete-localization", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "domain-localizations/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "DaprAppId", "declared_type": null, "nullable": false, "collection": false }, { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "get": { "operationId": "aurax-bff-get-localization-by-id", "tags": [ "domain-localizations" ], "summary": "aurax-bff-get-localization-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-get-localization-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "domain-localizations/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "DaprAppId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "LocalizationDto", "payload": "LocalizationDto", "collection": false, "members": [ { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Type", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Context", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Translations", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-domain-localization-by-id", "target_dapr_app_id": "aurax-management-service", "target_route": "domain-localizations/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "put": { "operationId": "aurax-bff-update-localization", "tags": [ "domain-localizations" ], "summary": "aurax-bff-update-localization", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-update-localization", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "domain-localizations/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "DaprAppId", "declared_type": null, "nullable": false, "collection": false }, { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Type", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/domain-matrix": { "get": { "operationId": "aurax-bff-redirect-get-matrix-list", "tags": [ "domain-matrix" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-matrix-list", "description": "Request and response fields are declared on the routing target `get-matrix-list`; this entry declares none of its own.", "parameters": [ { "name": "daprAppId", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "daprAppId" } }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 6 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a collection.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-matrix-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "domain-matrix", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-matrix-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "DaprAppId", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "MatrixDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ResultFieldDefinitionId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "MatrixColumns", "declared_type": "IEnumerable", "nullable": false, "collection": true }, { "name": "MatrixResults", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } }, "post": { "operationId": "aurax-bff-redirect-create-matrix-ui-bpm", "tags": [ "domain-matrix" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-create-matrix-ui-bpm", "description": "Request and response fields are declared on the routing target `create-matrix-ui-bpm`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "daprAppId": { "type": "string", "x-aura-field-code": "daprAppId" }, "description": { "type": "string", "x-aura-field-code": "matrixDescription" }, "matrixColumns": { "type": "array", "items": { "type": "object", "x-aura-field-code": "matrixColumns" } }, "matrixResults": { "type": "array", "items": { "type": "object", "x-aura-field-code": "matrixResults" } }, "name": { "type": "string", "x-aura-field-code": "matrixName" }, "resultFieldDefinitionId": { "type": "string", "format": "uuid", "x-aura-field-code": "resultFieldDefinitionId" } }, "required": [ "daprAppId", "description", "name", "resultFieldDefinitionId" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 6, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-matrix-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "domain-matrix", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/domain-matrix/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-matrix-ui-bpm", "tags": [ "domain-matrix" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-delete-matrix-ui-bpm", "description": "Request and response fields are declared on the routing target `delete-matrix-ui-bpm`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in this route template but not among the Route-bound fields of the routing target `delete-matrix-ui-bpm`, whose own path is decoupled from this one.", "x-aura-source": "route-template-only-after-collapse" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "daprAppId": { "type": "string", "x-aura-field-code": "daprAppId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "matrixId" } }, "required": [ "daprAppId", "id" ] } } }, "description": "The catalog declares Body-bound fields on this DELETE operation. Request bodies on DELETE have no defined semantics in HTTP; this documents the catalog, not a recommendation. Not every field below is accepted: the platform selects which of them this operation admits and drops the rest. Of the fields below, the binder does not admit `daprAppId`, `id`, which this document nevertheless marks required because the catalog declares them so.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 2, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [ "body" ], "dropped_field_names": { "body": [ "daprAppId", "id" ] }, "dropped_mandatory_field_names": [ "daprAppId", "id" ], "verdict": "declared-fields-not-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": "The HTTP edge in front of this operation comes in two shapes and they differ: the platform's typed route readers bind GET and DELETE from the URL and never read a body, while its untyped catalog-redirect reader collects the body whenever the request carries one. It does not change the answer above: the selection below happens after the edge, and excludes these fields either way." }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-matrix-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "domain-matrix/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "get": { "operationId": "aurax-bff-redirect-get-matrix-by-id", "tags": [ "domain-matrix" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-matrix-by-id", "description": "Request and response fields are declared on the routing target `get-matrix-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "matrixId" } }, { "name": "daprAppId", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "daprAppId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 1 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-matrix-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "domain-matrix/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "DaprAppId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "MatrixDto", "payload": "MatrixDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ResultFieldDefinitionId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "MatrixColumns", "declared_type": "IEnumerable", "nullable": false, "collection": true }, { "name": "MatrixResults", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } }, "put": { "operationId": "aurax-bff-redirect-update-matrix-ui-bpm", "tags": [ "domain-matrix" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-update-matrix-ui-bpm", "description": "Request and response fields are declared on the routing target `update-matrix`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "matrixId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "daprAppId": { "type": "string", "x-aura-field-code": "daprAppId" }, "description": { "type": "string", "x-aura-field-code": "matrixDescription" }, "matrixColumns": { "type": "array", "items": { "type": "object", "properties": { "columnCode": { "type": "string", "x-aura-field-code": "columnCode" }, "fieldDefinitionId": { "type": "string", "format": "uuid", "x-aura-field-code": "fieldDefinitionId" }, "matrixColumnId": { "type": "string", "format": "uuid", "x-aura-field-code": "matrixColumnId" }, "rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" } }, "required": [ "columnCode", "fieldDefinitionId", "matrixColumnId", "rowStatus" ], "x-aura-field-code": "matrixColumns" } }, "matrixResults": { "type": "array", "items": { "type": "object", "properties": { "matrixInputs": { "type": "array", "items": { "type": "object", "properties": { "inputValue": { "type": "string", "x-aura-field-code": "inputValue" }, "matrixColumnCode": { "type": "string", "x-aura-field-code": "matrixColumnCode" }, "matrixInputId": { "type": "string", "format": "uuid", "x-aura-field-code": "matrixInputId" }, "rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" } }, "required": [ "inputValue", "matrixColumnCode", "matrixInputId", "rowStatus" ], "x-aura-field-code": "matrixInputs" } }, "matrixResultId": { "type": "string", "format": "uuid", "x-aura-field-code": "matrixResultId" }, "resultValue": { "type": "string", "x-aura-field-code": "resultValue" }, "rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" } }, "required": [ "matrixInputs", "matrixResultId", "resultValue", "rowStatus" ], "x-aura-field-code": "matrixResults" } }, "name": { "type": "string", "x-aura-field-code": "matrixName" }, "resultFieldDefinitionId": { "type": "string", "format": "uuid", "x-aura-field-code": "resultFieldDefinitionId" } }, "required": [ "daprAppId", "description", "matrixColumns", "matrixResults", "name", "resultFieldDefinitionId" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 6, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-matrix-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "domain-matrix/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "ResultFieldDefinitionId", "declared_type": null, "nullable": true, "collection": false }, { "name": "DaprAppId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" } } }, "/domain-parameters": { "get": { "operationId": "aurax-bff-get-parameter-list", "tags": [ "domain-parameters" ], "summary": "aurax-bff-get-parameter-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-get-parameter-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "domain-parameters", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "DaprAppId", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "ParameterDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Translations", "declared_type": "IEnumerable", "nullable": false, "collection": true }, { "name": "ParameterFields", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-domain-parameter-list", "target_dapr_app_id": "aurax-management-service", "target_route": "domain-parameters", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-create-parameter", "tags": [ "domain-parameters" ], "summary": "aurax-bff-create-parameter", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-create-parameter", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "domain-parameters", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Code", "declared_type": null, "nullable": false, "collection": false }, { "name": "DaprAppId", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/domain-parameters/{id}": { "delete": { "operationId": "aurax-bff-delete-parameter", "tags": [ "domain-parameters" ], "summary": "aurax-bff-delete-parameter", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-delete-parameter", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "domain-parameters/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "DaprAppId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "get": { "operationId": "aurax-bff-get-parameter-by-id", "tags": [ "domain-parameters" ], "summary": "aurax-bff-get-parameter-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-get-parameter-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "domain-parameters/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "DaprAppId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ParameterDetailDto", "payload": "ParameterDetailDto", "collection": false, "members": [ { "name": "ParameterValues", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-domain-parameter-by-id", "target_dapr_app_id": "aurax-management-service", "target_route": "domain-parameters/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "put": { "operationId": "aurax-bff-update-parameter", "tags": [ "domain-parameters" ], "summary": "aurax-bff-update-parameter", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-update-parameter", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "domain-parameters/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": null, "nullable": false, "collection": false }, { "name": "DaprAppId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/domains": { "get": { "operationId": "aurax-bff-redirect-get-domain-definition-list", "tags": [ "domains" ], "summary": "aurax-bff-redirect-get-domain-definition-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-domain-definition-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "domains", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "DomainDefinitionDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DaprAppId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DaprNamespace", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Url", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ParentDomainId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "HasCompensation", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "Priority", "declared_type": "int", "nullable": false, "collection": false }, { "name": "HasBpm", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "Translations", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-domain-definition-list", "target_dapr_app_id": "core-service", "target_route": "domains", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-domain-definition", "tags": [ "domains" ], "summary": "aurax-bff-redirect-create-domain-definition", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-domain-definition", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "domains", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "DaprAppId", "declared_type": null, "nullable": false, "collection": false }, { "name": "DaprNamespace", "declared_type": null, "nullable": false, "collection": false }, { "name": "Url", "declared_type": null, "nullable": false, "collection": false }, { "name": "ParentDomainId", "declared_type": null, "nullable": true, "collection": false }, { "name": "HasCompensation", "declared_type": null, "nullable": false, "collection": false }, { "name": "Priority", "declared_type": null, "nullable": false, "collection": false }, { "name": "HasBpm", "declared_type": null, "nullable": true, "collection": false }, { "name": "Code", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "command-id", "note": "The route returns `AuraCommandDto`, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, `Id`, of type `Guid`. A caller gets a JSON OBJECT with one field, not a bare value. The field is `id` on the wire.", "declared_type": "AuraCommandDto", "envelopes": [ "AuraCommandDto" ], "payload": "Guid", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false, "wire_name": "id", "wire_name_basis": "framework-naming-policy" } ], "naming": "Member names are the service's declaration names.", "synthesized": true, "forwarded": { "service_code": "create-domain-definition", "target_dapr_app_id": "core-service", "target_route": "domains", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_CORE_22", "status": 400, "message": { "ar": "هناك بالفعل نطاق باسم هذا.", "en": "There is already a domain with this name.", "tr": "Bu ada sahip bir alan adı zaten var." }, "message_available": true, "constant_name": "EXISTS_DOMAIN_DEFINITION_WITH_THIS_NAME" }, { "code": "ERR_CORE_23", "status": 400, "message": { "ar": "يوجد بالفعل نطاق بهذا الرمز.", "en": "There is already a domain with this code.", "tr": "Bu koda sahip bir alan adı zaten var." }, "message_available": true, "constant_name": "EXISTS_DOMAIN_DEFINITION_WITH_THIS_CODE" }, { "code": "ERR_CORE_25", "status": 400, "message": { "ar": "لم يتم العثور على parentDomainId.", "en": "Parent Domain cannot be found.", "tr": "Üst alan adı bulunamadı." }, "message_available": true, "constant_name": "PARENT_DOMAIN_DEFINITION_ID_IS_NOT_FOUND" }, { "code": "ERR_CORE_26", "status": 400, "message": { "ar": "هناك نطاق بالفعل باستخدام هذا الـ daprAppId.", "en": "There is already a domain with this daprApp.", "tr": "Bu daprApp e sahip bir alan zaten var." }, "message_available": true, "constant_name": "EXISTS_DOMAIN_DEFINITION_WITH_THIS_DAPPR_ID" }, { "code": "ERR_CORE_77", "status": 400, "message": { "ar": "هناك بالفعل مجال بهذا الرابط.", "en": "There is already a domian with this url.", "tr": "Bu urlye sahip bir alan adı zaten var." }, "message_available": true, "constant_name": "THERE_IS_ALREADY_DOMIAN_DEFINITION_WITH_THIS_URL" } ] } } }, "/domains/{id}": { "get": { "operationId": "aurax-bff-redirect-get-domain-definition-by-id", "tags": [ "domains" ], "summary": "aurax-bff-redirect-get-domain-definition-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-domain-definition-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "domains/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "DomainDefinitionDto", "payload": "DomainDefinitionDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DaprAppId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DaprNamespace", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Url", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ParentDomainId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "HasCompensation", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "Priority", "declared_type": "int", "nullable": false, "collection": false }, { "name": "HasBpm", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "Translations", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-domain-definition-by-id", "target_dapr_app_id": "core-service", "target_route": "domains/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_CORE_31", "status": 400, "message": { "ar": "لم يتم العثور على معرف النطاق (domainId).", "en": "Domain cannot be found.", "tr": "Etki alanı bulunamadı." }, "message_available": true, "constant_name": "DOMAIN_ID_IS_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-domain-definition", "tags": [ "domains" ], "summary": "aurax-bff-redirect-update-domain-definition", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-domain-definition", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "domains/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Priority", "declared_type": null, "nullable": false, "collection": false }, { "name": "HasBpm", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "forwarded": { "service_code": "update-domain-definition", "target_dapr_app_id": "core-service", "target_route": "domains/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_CORE_134", "status": 400, "message": { "ar": "حقل isActive لا يمكن أن يكون فارغًا.", "en": "isActive field cannot be left blank.", "tr": "Aktiflik alanı boş bırakılamaz." }, "message_available": true, "constant_name": "IS_ACTIVE_NOT_BE_NULL" }, { "code": "ERR_CORE_146", "status": 400, "message": { "ar": "هل حقل معدل ضربات القلب (Bpm) لا يمكن أن يكون فارغًا؟", "en": "Has Bpm field cannot be left blank.", "tr": "BPM alanı boş bırakılamaz." }, "message_available": true, "constant_name": "HAS_BPM_NOT_BE_NULL" }, { "code": "ERR_CORE_31", "status": 400, "message": { "ar": "لم يتم العثور على معرف النطاق (domainId).", "en": "Domain cannot be found.", "tr": "Etki alanı bulunamadı." }, "message_available": true, "constant_name": "DOMAIN_ID_IS_NOT_FOUND" } ] } } }, "/easy-addresses": { "get": { "operationId": "aurax-bff-service-dynamic-get-easy-address-list", "tags": [ "easy-addresses" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-get-easy-address-list", "description": "Request and response fields are declared on the routing target `get-easy-address-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "accountId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountId" }, "addressTypeValue": { "type": "string", "x-aura-field-code": "addressTypeValue" }, "channelId": { "type": "string", "format": "uuid", "x-aura-field-code": "channelId" }, "description": { "type": "string", "x-aura-field-code": "description" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "easyAddressId" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "status" }, "systemReferenceNumber": { "type": "string", "x-aura-field-code": "systemReferenceNumber" }, "transactionid": { "type": "string", "x-aura-field-code": "transactionid" }, "type": { "type": "string", "x-aura-field-code": "easyAddressType" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-get-easy-address-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "easy-addresses", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-easy-address-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "route-claimed-by-two-repositories", "note": "Two services register this method and path, so this portal cannot say which one's request fields these would be. The fields a caller sends are exactly what would differ between them, so nothing is published rather than one of the two." }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "EasyAddressDto", "collection": true, "members": [ { "name": "Status", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Type", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "AccountId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "AddressTypeValue", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransactionId", "declared_type": "string", "nullable": false, "collection": false, "wire_name": "transactionid", "wire_name_basis": "declared" }, { "name": "SystemReferenceNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ChannelId", "declared_type": "Guid?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names, except where a member states a wire name — there the wire name is the key to send." } } }, "/easy-addresses/by-customer-id/{customerId}": { "get": { "operationId": "aurax-bff-redirect-get-easy-address-list-by-customer-id", "tags": [ "easy-addresses" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-easy-address-list-by-customer-id", "description": "Request and response fields are declared on the routing target `get-easy-address-list-by-customer-id`; this entry declares none of its own.", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" } }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a collection.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-easy-address-list-by-customer-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "easy-addresses/by-customer-id/{customerId}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "EasyAddressDto", "collection": true, "members": [ { "name": "Status", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Type", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "AccountId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "AddressTypeValue", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransactionId", "declared_type": "string", "nullable": false, "collection": false, "wire_name": "transactionid", "wire_name_basis": "declared" }, { "name": "SystemReferenceNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ChannelId", "declared_type": "Guid?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names, except where a member states a wire name — there the wire name is the key to send." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/eledger-request/upload": { "post": { "operationId": "aurax-bff-redirect-generate-eledger-report", "tags": [ "eledger-request" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-generate-eledger-report", "description": "Request and response fields are declared on the routing target `generate-eledger-report`; this entry declares none of its own.", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-generate-eledger-report", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "eledger-request/upload", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "no-members" }, "x-aura-code-response": { "state": "structure", "declared_type": "EledgerReportDto", "payload": "EledgerReportDto", "collection": false, "members": [ { "name": "ReportPath", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_236", "status": 400, "message": { "ar": "الطلب الإلكتروني غير موجود للمعرف المعطى", "en": "Eledger request is not exists for given id", "tr": "Verilen kimlik için Eledger isteği mevcut değil" }, "message_available": true, "constant_name": "ELEDGER_REQUEST_IS_NOT_EXISTS_FOR_GIVEN_ID" } ] } } }, "/eledger-requests": { "get": { "operationId": "aurax-bff-redirect-get-eledger-request-list", "tags": [ "eledger-requests" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-eledger-request-list", "description": "Request and response fields are declared on the routing target `get-eledger-request-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "beginDate": { "type": "string", "format": "date", "x-aura-field-code": "eledgerRequestBeginDate" }, "description": { "type": "string", "x-aura-field-code": "eledgerRequestDescription" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "eledgerRequestEndDate" }, "fileFormat": { "type": "integer", "format": "int32", "x-aura-field-code": "fileFormat" }, "fileName": { "type": "string", "x-aura-field-code": "fileName" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "lastEntryNumber": { "type": "string", "x-aura-field-code": "lastEntryNumber" }, "lastLineNumber": { "type": "string", "x-aura-field-code": "lastLineNumber" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "status" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-eledger-request-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "eledger-requests", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-eledger-request-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Filter", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "EledgerRequestDto", "collection": true, "members": [ { "name": "BeginDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "EndDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "LastEntryNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LastLineNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FileFormat", "declared_type": "int", "nullable": false, "collection": false }, { "name": "FileName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "int", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } }, "post": { "operationId": "aurax-bff-redirect-create-eledger-request", "tags": [ "eledger-requests" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-create-eledger-request", "description": "Request and response fields are declared on the routing target `create-eledger-request`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "beginDate": { "type": "string", "format": "date", "x-aura-field-code": "eledgerRequestBeginDate" }, "description": { "type": "string", "x-aura-field-code": "eledgerRequestDescription" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "eledgerRequestEndDate" }, "fileFormat": { "type": "integer", "format": "int32", "x-aura-field-code": "fileFormat", "x-aura-parameter-enumeration": { "state": "resolved", "parameter": "file_format", "values": [ { "value": 1, "name": "xml" }, { "value": 2, "name": "csv" }, { "value": 3, "name": "json" } ] } } }, "required": [ "beginDate", "description", "endDate", "fileFormat" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 4, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-eledger-request", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "eledger-requests", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "BeginDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "EndDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "FileFormat", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "command-id", "note": "The route returns `AuraCommandDto`, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, `Id`, of type `Guid`. A caller gets a JSON OBJECT with one field, not a bare value. The field is `id` on the wire.", "declared_type": "AuraCommandDto", "envelopes": [ "AuraCommandDto" ], "payload": "Guid", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false, "wire_name": "id", "wire_name_basis": "framework-naming-policy" } ], "naming": "Member names are the service's declaration names.", "synthesized": true }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_234", "status": 400, "message": { "ar": "الطلب موجود بالفعل بالتاريخين المحددين للبداية والنهاية", "en": "Request is already existing with given begin and end date", "tr": "İstek, belirtilen başlangıç ​​ve bitiş tarihiyle zaten mevcut" }, "message_available": true, "constant_name": "REQUEST_IS_ALREADY_EXISTING_WITH_GIVEN_BEGIN_AND_END_DATE" }, { "code": "ERR_ACCTNG_237", "status": 400, "message": { "ar": "لا يمكن أن يكون تاريخ البدء أكبر من تاريخ الانتهاء", "en": "Begin date cannot be greater than end date", "tr": "Başlangıç ​​tarihi bitiş tarihinden büyük olamaz" }, "message_available": true, "constant_name": "BEGIN_DATE_CONNNOT_BE_GREATER_THAN_END_DATE" }, { "code": "ERR_ACCTNG_238", "status": 400, "message": { "ar": "يجب أن تكون الطلبات السابقة على دفتر الحسابات جاهزة", "en": "Previous eledger request must be ready", "tr": "Önceki eledger talebinin hazır olması gerekiyor" }, "message_available": true, "constant_name": "PREVIOUS_ELEDGER_REQUEST_MUST_BE_READY" } ] } } }, "/eledger-requests/{id}": { "get": { "operationId": "aurax-bff-redirect-get-eledger-request-by-id", "tags": [ "eledger-requests" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-eledger-request-by-id", "description": "Request and response fields are declared on the routing target `get-eledger-request-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "eledgerRequestId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "beginDate": { "type": "string", "format": "date", "x-aura-field-code": "eledgerRequestBeginDate" }, "description": { "type": "string", "x-aura-field-code": "eledgerRequestDescription" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "eledgerRequestEndDate" }, "fileFormat": { "type": "integer", "format": "int32", "x-aura-field-code": "fileFormat" }, "fileName": { "type": "string", "x-aura-field-code": "fileName" }, "lastEntryNumber": { "type": "string", "x-aura-field-code": "lastEntryNumber" }, "lastLineNumber": { "type": "string", "x-aura-field-code": "lastLineNumber" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "eledgerRequestStatus" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-eledger-request-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "eledger-requests/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "EledgerRequestDto", "payload": "EledgerRequestDto", "collection": false, "members": [ { "name": "BeginDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "EndDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "LastEntryNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LastLineNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FileFormat", "declared_type": "int", "nullable": false, "collection": false }, { "name": "FileName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "int", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_236", "status": 400, "message": { "ar": "الطلب الإلكتروني غير موجود للمعرف المعطى", "en": "Eledger request is not exists for given id", "tr": "Verilen kimlik için Eledger isteği mevcut değil" }, "message_available": true, "constant_name": "ELEDGER_REQUEST_IS_NOT_EXISTS_FOR_GIVEN_ID" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-eledger-request", "tags": [ "eledger-requests" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-update-eledger-request", "description": "Request and response fields are declared on the routing target `update-eledger-request`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "eledgerRequestId" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "beginDate": { "type": "string", "format": "date", "x-aura-field-code": "eledgerRequestBeginDate" }, "description": { "type": "string", "x-aura-field-code": "eledgerRequestDescription" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "eledgerRequestEndDate" }, "fileFormat": { "type": "integer", "format": "int32", "x-aura-field-code": "fileFormat", "x-aura-parameter-enumeration": { "state": "resolved", "parameter": "file_format", "values": [ { "value": 1, "name": "xml" }, { "value": 2, "name": "csv" }, { "value": 3, "name": "json" } ] } }, "fileName": { "type": "string", "x-aura-field-code": "fileName" }, "lastEntryNumber": { "type": "string", "x-aura-field-code": "lastEntryNumber" }, "lastLineNumber": { "type": "string", "x-aura-field-code": "lastLineNumber" } } } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 7, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-eledger-request", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "eledger-requests/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeginDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "EndDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "LastEntryNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "LastLineNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "FileFormat", "declared_type": null, "nullable": true, "collection": false }, { "name": "FileName", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_234", "status": 400, "message": { "ar": "الطلب موجود بالفعل بالتاريخين المحددين للبداية والنهاية", "en": "Request is already existing with given begin and end date", "tr": "İstek, belirtilen başlangıç ​​ve bitiş tarihiyle zaten mevcut" }, "message_available": true, "constant_name": "REQUEST_IS_ALREADY_EXISTING_WITH_GIVEN_BEGIN_AND_END_DATE" }, { "code": "ERR_ACCTNG_236", "status": 400, "message": { "ar": "الطلب الإلكتروني غير موجود للمعرف المعطى", "en": "Eledger request is not exists for given id", "tr": "Verilen kimlik için Eledger isteği mevcut değil" }, "message_available": true, "constant_name": "ELEDGER_REQUEST_IS_NOT_EXISTS_FOR_GIVEN_ID" }, { "code": "ERR_ACCTNG_237", "status": 400, "message": { "ar": "لا يمكن أن يكون تاريخ البدء أكبر من تاريخ الانتهاء", "en": "Begin date cannot be greater than end date", "tr": "Başlangıç ​​tarihi bitiş tarihinden büyük olamaz" }, "message_available": true, "constant_name": "BEGIN_DATE_CONNNOT_BE_GREATER_THAN_END_DATE" }, { "code": "ERR_ACCTNG_238", "status": 400, "message": { "ar": "يجب أن تكون الطلبات السابقة على دفتر الحسابات جاهزة", "en": "Previous eledger request must be ready", "tr": "Önceki eledger talebinin hazır olması gerekiyor" }, "message_available": true, "constant_name": "PREVIOUS_ELEDGER_REQUEST_MUST_BE_READY" } ] } } }, "/eledger-requests/{id}/status": { "put": { "operationId": "aurax-bff-redirect-update-eledger-request-status", "tags": [ "eledger-requests" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-update-eledger-request-status", "description": "Request and response fields are declared on the routing target `update-eledger-request-status`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "eledgerRequestId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "format": "int32", "x-aura-field-code": "eledgerRequestStatus", "x-aura-parameter-enumeration": { "state": "resolved", "parameter": "eledger_request_status", "values": [ { "value": 0, "name": "Requested", "labels": { "en": "Requested", "tr": "Talep edildi", "ar": "مطلوب" } }, { "value": 1, "name": "Preparing", "labels": { "en": "Preparing", "tr": "Hazırlanıyor", "ar": "التحضير" } }, { "value": 2, "name": "Ready", "labels": { "en": "Ready", "tr": "Hazırlandı", "ar": "جاهز" } }, { "value": 3, "name": "Cancelled", "labels": { "en": "Cancelled", "tr": "İptal edildi", "ar": "ملغاة" } }, { "value": 4, "name": "Error Received", "labels": { "en": "Error Received", "tr": "Hata alındı", "ar": "تم استلام خطأ" } } ] } } }, "required": [ "status" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-eledger-request-status", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "eledger-requests/{id}/status", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_236", "status": 400, "message": { "ar": "الطلب الإلكتروني غير موجود للمعرف المعطى", "en": "Eledger request is not exists for given id", "tr": "Verilen kimlik için Eledger isteği mevcut değil" }, "message_available": true, "constant_name": "ELEDGER_REQUEST_IS_NOT_EXISTS_FOR_GIVEN_ID" } ] } } }, "/events": { "get": { "operationId": "aurax-bff-redirect-get-event-definition-list", "tags": [ "events" ], "summary": "aurax-bff-redirect-get-event-definition-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-event-definition-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "events", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "EventDefinitionDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "EventType", "declared_type": "int?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-event-definition-list", "target_dapr_app_id": "core-service", "target_route": "events", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-event-definition-ui", "tags": [ "events" ], "summary": "aurax-bff-redirect-create-event-definition-ui", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-event-definition-ui", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "events", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Code", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "EventType", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/events/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-event-definition", "tags": [ "events" ], "summary": "aurax-bff-redirect-delete-event-definition", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-event-definition", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "events/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "forwarded": { "service_code": "delete-event-definition", "target_dapr_app_id": "core-service", "target_route": "events/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_CORE_63", "status": 400, "message": { "ar": "لم يتم العثور على معرف الحدث.", "en": "Event cannot be found.", "tr": "Olay bulunamadı." }, "message_available": true, "constant_name": "EVENT_ID_IS_NOT_FOUND" } ] } }, "get": { "operationId": "aurax-bff-redirect-get-event-definition-by-id", "tags": [ "events" ], "summary": "aurax-bff-redirect-get-event-definition-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-event-definition-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "events/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "EventDefinitionDto", "payload": "EventDefinitionDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "EventType", "declared_type": "int?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-event-definition-by-id", "target_dapr_app_id": "core-service", "target_route": "events/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_CORE_63", "status": 400, "message": { "ar": "لم يتم العثور على معرف الحدث.", "en": "Event cannot be found.", "tr": "Olay bulunamadı." }, "message_available": true, "constant_name": "EVENT_ID_IS_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-event-definition-ui", "tags": [ "events" ], "summary": "aurax-bff-redirect-update-event-definition-ui", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-event-definition-ui", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "events/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "EventType", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/events/{id}/requests": { "get": { "operationId": "aurax-bff-redirect-get-event-definition-request-list", "tags": [ "events" ], "summary": "aurax-bff-redirect-get-event-definition-request-list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-event-definition-request-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "events/{id}/requests", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": true, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "EventDefinitionRequestDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DefaultValue", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Necessity", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Location", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "FieldId", "declared_type": "Guid?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-event-definition-request-list", "target_dapr_app_id": "core-service", "target_route": "events/{id}/requests", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_CORE_63", "status": 400, "message": { "ar": "لم يتم العثور على معرف الحدث.", "en": "Event cannot be found.", "tr": "Olay bulunamadı." }, "message_available": true, "constant_name": "EVENT_ID_IS_NOT_FOUND" } ] } } }, "/exchange-rates/by-base-currency/{currencyNumber}": { "get": { "operationId": "aurax-bff-get-exchange-rate-by-base-currency", "tags": [ "exchange-rates" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-get-exchange-rate-by-base-currency", "description": "Request and response fields are declared on the routing target `get-exchange-rate-by-base-currency`; this entry declares none of its own.", "parameters": [ { "name": "currencyNumber", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "currencyNumber" } }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "code" }, "expression": { "type": "string", "x-aura-field-code": "expression" }, "parameters": { "type": "object", "x-aura-field-code": "filterParameters" } }, "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } }, { "name": "rateDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "x-aura-field-code": "rateDate" } }, { "name": "spreadType", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "spreadType" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 7 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "exchangeRates": { "type": "array", "items": { "type": "object", "properties": { "askRate": { "type": "number", "format": "decimal", "x-aura-field-code": "askRate" }, "bidRate": { "type": "number", "format": "decimal", "x-aura-field-code": "bidRate" }, "currencyPairCode": { "type": "string", "x-aura-field-code": "currencyPairCode" }, "effectiveAskRate": { "type": "number", "format": "decimal", "x-aura-field-code": "effectiveAskRate" }, "effectiveBidRate": { "type": "number", "format": "decimal", "x-aura-field-code": "effectiveBidRate" }, "midRate": { "type": "number", "format": "decimal", "x-aura-field-code": "midRate" }, "spreadType": { "type": "integer", "format": "int32", "x-aura-field-code": "spreadType" } }, "x-aura-field-code": "exchangeRates" } }, "rateDate": { "type": "string", "format": "date", "x-aura-field-code": "rateDate" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-get-exchange-rate-by-base-currency", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "exchange-rates/by-base-currency/{currencyNumber}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CurrencyNumber", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ExchangeRateDto", "payload": "ExchangeRateDto", "collection": false, "members": [ { "name": "RateDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "ExchangeRates", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_EXCRT_2", "status": 400, "message": null, "message_available": false, "constant_name": "EXCHANGE_RATE_IS_NOT_FOUND_FOR_GIVEN_INPUTS" }, { "code": "ERR_EXCRT_7", "status": 400, "message": null, "message_available": false, "constant_name": "CURRENCY_PAIR_NOT_FOUND_FOR_EXCHANGE_RATE" } ] } } }, "/expense-collections": { "get": { "operationId": "aurax-bff-redirect-get-expense-collections", "tags": [ "expense-collections" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-expense-collections", "description": "Request and response fields are declared on the routing target `get-expense-collections`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "accountId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountId" }, "accountingEntryId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryId" }, "cancelAccountingEntryId": { "type": "string", "format": "uuid", "x-aura-field-code": "cancelAccountingEntryId" }, "cancelDate": { "type": "string", "format": "date-time", "x-aura-field-code": "cancelDate" }, "cancelDescription": { "type": "string", "x-aura-field-code": "cancelDescription" }, "collectionAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "collectionAmount" }, "collectionAmountLocal": { "type": "number", "format": "decimal", "x-aura-field-code": "collectionAmountLocal" }, "collectionSubType": { "type": "integer", "format": "int32", "x-aura-field-code": "collectionSubType" }, "collectionType": { "type": "integer", "format": "int32", "x-aura-field-code": "collectionType" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "exchangeRate": { "type": "number", "format": "decimal", "x-aura-field-code": "exchangeRate" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "expenseCollectionId" }, "installmentReferenceId": { "type": "string", "format": "uuid", "x-aura-field-code": "installmentReferenceId" }, "transactionDate": { "type": "string", "format": "date", "x-aura-field-code": "transactionDate" }, "transactionDescription": { "type": "string", "x-aura-field-code": "transactionDescription" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-expense-collections", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "expense-collections", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "note": "Platform-provided behaviours declared on the routing target `get-expense-collections`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Filter", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "ExpenseCollectionDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AccountId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CollectionSubType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CollectionType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Amount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "AmountLocal", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "ExchangeRate", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "AccountingEntryId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "RelatedAccountingEntryId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransactionDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "ExpenseInstallmentId", "declared_type": "Guid?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/expense-collections/{id}": { "get": { "operationId": "aurax-bff-redirect-get-expense-collection-by-id", "tags": [ "expense-collections" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-expense-collection-by-id", "description": "Request and response fields are declared on the routing target `get-expense-collection-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "expenseCollectionId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-expense-collection-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "expense-collections/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ExpenseCollectionDto", "payload": "ExpenseCollectionDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AccountId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CollectionSubType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CollectionType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Amount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "AmountLocal", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "ExchangeRate", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "AccountingEntryId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "RelatedAccountingEntryId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransactionDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "ExpenseInstallmentId", "declared_type": "Guid?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_EXPNS_45", "status": 400, "message": null, "message_available": false, "constant_name": "EXPENSE_COLLECTION_NOT_FOUND" } ] } } }, "/expense-items": { "get": { "operationId": "aurax-bff-redirect-get-expense-item-list", "tags": [ "expense-items" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-expense-item-list", "description": "Request and response fields are declared on the routing target `get-expense-item-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a collection.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-expense-item-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "expense-items", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-expense-item-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "ExpenseItemDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "StartDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "EndDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "ExpenseType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ParentExpenseItemId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "AccountingEntryDefinitionCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsLeafLevel", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "IsAccrual", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "IsPartialCollection", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "DomainCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CalculationTypes", "declared_type": "List", "nullable": false, "collection": true }, { "name": "CalculationTaxes", "declared_type": "List", "nullable": false, "collection": true }, { "name": "ExpenseRuleMaps", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } }, "post": { "operationId": "aurax-bff-redirect-create-expense-item-ui-bpm", "tags": [ "expense-items" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-create-expense-item-ui-bpm", "description": "Request and response fields are declared on the routing target `create-expense-item-ui-bpm`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "accountingEntryDefinitionCode": { "type": "string", "x-aura-field-code": "accountingEntryDefinitionCode" }, "calculationTaxes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "expenseItemId" }, "taxCondition": { "type": "integer", "format": "int32", "x-aura-field-code": "taxCondition" }, "taxId": { "type": "string", "format": "uuid", "x-aura-field-code": "taxId" } }, "required": [ "id", "taxCondition", "taxId" ], "x-aura-field-code": "calculationTaxes" } }, "calculationTypes": { "type": "array", "items": { "type": "object", "properties": { "calculationType": { "type": "integer", "format": "int32", "x-aura-field-code": "calculationType" }, "customerTypes": { "type": "array", "items": { "type": "object", "properties": { "customerType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerType" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "expenseItemId" } }, "required": [ "customerType", "id" ], "x-aura-field-code": "customerTypes" } }, "formulaDefinitionId": { "type": "string", "format": "uuid", "x-aura-field-code": "formulaDefinitionId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "expenseItemId" }, "ranges": { "type": "array", "items": { "type": "object", "properties": { "constantExpense": { "type": "number", "x-aura-field-code": "constantExpense" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "expenseItemId" }, "maxConstantExpense": { "type": "number", "format": "decimal", "x-aura-field-code": "maxConstantExpense" }, "maxExpenseAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "maxExpenseAmount" }, "maxRate": { "type": "number", "format": "decimal", "x-aura-field-code": "maxRate" }, "maxTranAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "maxTranAmount" }, "minConstantExpense": { "type": "number", "format": "decimal", "x-aura-field-code": "minConstantExpense" }, "minExpenseAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "minExpenseAmount" }, "minRate": { "type": "number", "format": "decimal", "x-aura-field-code": "minRate" }, "minTranAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "minTranAmount" }, "rate": { "type": "number", "format": "decimal", "x-aura-field-code": "rate" } }, "required": [ "currencyNumber", "id", "maxExpenseAmount", "maxTranAmount", "minExpenseAmount", "minTranAmount" ], "x-aura-field-code": "ranges" } } }, "required": [ "calculationType", "id" ], "x-aura-field-code": "calculationTypes" } }, "code": { "type": "string", "x-aura-field-code": "code" }, "description": { "type": "string", "x-aura-field-code": "description" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "expenseRuleMaps": { "type": "array", "items": { "type": "object", "properties": { "expenseRuleId": { "type": "string", "format": "uuid", "x-aura-field-code": "expenseRuleId" } }, "required": [ "expenseRuleId" ], "x-aura-field-code": "expenseRuleMaps" } }, "expenseType": { "type": "integer", "format": "int32", "x-aura-field-code": "expenseType" }, "isAccrual": { "type": "boolean", "x-aura-field-code": "isAccrual" }, "isPartialCollection": { "type": "boolean", "x-aura-field-code": "isPartialCollection" }, "name": { "type": "string", "x-aura-field-code": "name", "x-aura-maskable": true }, "parentExpenseItemId": { "type": "string", "format": "uuid", "x-aura-field-code": "parentExpenseItemId" }, "startDate": { "type": "string", "format": "date-time", "x-aura-field-code": "startDate" } }, "required": [ "accountingEntryDefinitionCode", "code", "description", "endDate", "expenseType", "isAccrual", "isPartialCollection", "name", "startDate" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 13, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-expense-item-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "expense-items", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Code", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "StartDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "EndDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "ExpenseType", "declared_type": null, "nullable": true, "collection": false }, { "name": "ParentExpenseItemId", "declared_type": null, "nullable": true, "collection": false }, { "name": "AccountingEntryDefinitionCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsAccrual", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsPartialCollection", "declared_type": null, "nullable": true, "collection": false }, { "name": "DomainCode", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/expense-items/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-expense-item-ui-bpm", "tags": [ "expense-items" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-delete-expense-item-ui-bpm", "description": "Request and response fields are declared on the routing target `delete-expense-item-ui-bpm`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "expenseItemId" } } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-expense-item-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "expense-items/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "get": { "operationId": "aurax-bff-redirect-get-expense-item-by-id", "tags": [ "expense-items" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-expense-item-by-id", "description": "Request and response fields are declared on the routing target `get-expense-item-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "expenseItemId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-expense-item-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "expense-items/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ExpenseItemDto", "payload": "ExpenseItemDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "StartDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "EndDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "ExpenseType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ParentExpenseItemId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "AccountingEntryDefinitionCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsLeafLevel", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "IsAccrual", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "IsPartialCollection", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "DomainCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CalculationTypes", "declared_type": "List", "nullable": false, "collection": true }, { "name": "CalculationTaxes", "declared_type": "List", "nullable": false, "collection": true }, { "name": "ExpenseRuleMaps", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_EXPNS_7", "status": 400, "message": null, "message_available": false, "constant_name": "EXPENSE_ITEM_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-expense-item-ui-bpm", "tags": [ "expense-items" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-update-expense-item-ui-bpm", "description": "Request and response fields are declared on the routing target `update-expense-item-ui-bpm`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "expenseItemId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "accountingEntryDefinitionCode": { "type": "string", "x-aura-field-code": "accountingEntryDefinitionCode" }, "calculationTaxes": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "_rowStatus" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "expenseItemCalculationTaxId" }, "taxCondition": { "type": "integer", "format": "int32", "x-aura-field-code": "taxCondition" }, "taxId": { "type": "string", "format": "uuid", "x-aura-field-code": "taxId" } }, "required": [ "id", "taxCondition", "taxId" ], "x-aura-field-code": "calculationTaxes" } }, "calculationTypes": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "_rowStatus" }, "calculationType": { "type": "integer", "format": "int32", "x-aura-field-code": "calculationType" }, "customerTypes": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "_rowStatus" }, "customerType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerType" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "expenseItemCustomerTypeId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" } }, "required": [ "customerType", "id", "isActive" ], "x-aura-field-code": "customerTypes" } }, "expenseItemId": { "type": "string", "format": "uuid", "x-aura-field-code": "expenseItemId" }, "formulaDefinitionId": { "type": "string", "format": "uuid", "x-aura-field-code": "formulaDefinitionId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "expenseItemCalculationTypeId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "ranges": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "_rowStatus" }, "constantExpense": { "type": "number", "x-aura-field-code": "constantExpense" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "expenseItemCalculationRangeId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "maxConstantExpense": { "type": "number", "format": "decimal", "x-aura-field-code": "maxConstantExpense" }, "maxExpenseAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "maxExpenseAmount" }, "maxRate": { "type": "number", "format": "decimal", "x-aura-field-code": "maxRate" }, "maxTranAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "maxTranAmount" }, "minConstantExpense": { "type": "number", "format": "decimal", "x-aura-field-code": "minConstantExpense" }, "minExpenseAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "minExpenseAmount" }, "minRate": { "type": "number", "format": "decimal", "x-aura-field-code": "minRate" }, "minTranAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "minTranAmount" }, "rate": { "type": "number", "format": "decimal", "x-aura-field-code": "rate" } }, "required": [ "currencyNumber", "id", "isActive", "maxTranAmount", "minTranAmount" ], "x-aura-field-code": "ranges" } } }, "required": [ "calculationType", "id", "isActive" ], "x-aura-field-code": "calculationTypes" } }, "code": { "type": "string", "x-aura-field-code": "code" }, "description": { "type": "string", "x-aura-field-code": "description" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "expenseRuleMaps": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "_rowStatus" }, "expenseRuleId": { "type": "string", "format": "uuid", "x-aura-field-code": "expenseRuleId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "expenseRuleMapId" } }, "required": [ "expenseRuleId" ], "x-aura-field-code": "expenseRuleMaps" } }, "expenseType": { "type": "integer", "format": "int32", "x-aura-field-code": "expenseType" }, "isAccrual": { "type": "boolean", "x-aura-field-code": "isAccrual" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "isPartialCollection": { "type": "boolean", "x-aura-field-code": "isPartialCollection" }, "name": { "type": "string", "x-aura-field-code": "name", "x-aura-maskable": true }, "parentExpenseItemId": { "type": "string", "format": "uuid", "x-aura-field-code": "parentExpenseItemId" }, "startDate": { "type": "string", "format": "date-time", "x-aura-field-code": "startDate" } }, "required": [ "accountingEntryDefinitionCode", "code", "description", "endDate", "expenseType", "isAccrual", "isActive", "isPartialCollection", "name", "startDate" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 14, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-expense-item-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "expense-items/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "StartDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "EndDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "ExpenseType", "declared_type": null, "nullable": true, "collection": false }, { "name": "ParentExpenseItemId", "declared_type": null, "nullable": true, "collection": false }, { "name": "AccountingEntryDefinitionCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsAccrual", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsPartialCollection", "declared_type": null, "nullable": true, "collection": false }, { "name": "DomainCode", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/expense-rules": { "get": { "operationId": "aurax-bff-redirect-get-expense-rule-list", "tags": [ "expense-rules" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-expense-rule-list", "description": "Request and response fields are declared on the routing target `get-expense-rule-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a collection.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-expense-rule-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "expense-rules", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-expense-rule-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "ExpenseRuleDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "RuleType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "FormulaDefinitionId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "RuleCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RuleName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "StartDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "EndDate", "declared_type": "DateOnly?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } }, "post": { "operationId": "aurax-bff-redirect-create-expense-rule-ui-bpm", "tags": [ "expense-rules" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-create-expense-rule-ui-bpm", "description": "Request and response fields are declared on the routing target `create-expense-rule-ui-bpm`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "formula": { "type": "string", "x-aura-field-code": "formula" }, "ruleCode": { "type": "string", "x-aura-field-code": "ruleCode" }, "ruleName": { "type": "string", "x-aura-field-code": "ruleName" }, "ruleType": { "type": "integer", "format": "int32", "x-aura-field-code": "ruleType" }, "startDate": { "type": "string", "format": "date-time", "x-aura-field-code": "startDate" } }, "required": [ "endDate", "formula", "ruleCode", "ruleName", "ruleType", "startDate" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 6, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-expense-rule-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "expense-rules", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "RuleType", "declared_type": null, "nullable": false, "collection": false }, { "name": "FormulaDefinitionId", "declared_type": null, "nullable": false, "collection": false }, { "name": "RuleCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "RuleName", "declared_type": null, "nullable": false, "collection": false }, { "name": "StartDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "EndDate", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/expense-rules/{id}": { "get": { "operationId": "aurax-bff-redirect-get-expense-rule-by-id", "tags": [ "expense-rules" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-expense-rule-by-id", "description": "Request and response fields are declared on the routing target `get-expense-rule-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "expenseRuleId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-expense-rule-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "expense-rules/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ExpenseRuleDto", "payload": "ExpenseRuleDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "RuleType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "FormulaDefinitionId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "RuleCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RuleName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "StartDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "EndDate", "declared_type": "DateOnly?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_EXPNS_29", "status": 400, "message": null, "message_available": false, "constant_name": "EXPENSE_RULE_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-expense-rule-ui-bpm", "tags": [ "expense-rules" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-update-expense-rule-ui-bpm", "description": "Request and response fields are declared on the routing target `update-expense-rule-ui-bpm`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "expenseRuleId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "formula": { "type": "string", "x-aura-field-code": "formula" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "ruleCode": { "type": "string", "x-aura-field-code": "ruleCode" }, "ruleName": { "type": "string", "x-aura-field-code": "ruleName" }, "ruleType": { "type": "integer", "format": "int32", "x-aura-field-code": "ruleType" }, "startDate": { "type": "string", "format": "date-time", "x-aura-field-code": "startDate" } }, "required": [ "endDate", "formula", "isActive", "ruleCode", "ruleName", "ruleType", "startDate" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 7, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-expense-rule-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "expense-rules/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "RuleType", "declared_type": null, "nullable": false, "collection": false }, { "name": "FormulaDefinitionId", "declared_type": null, "nullable": false, "collection": false }, { "name": "RuleName", "declared_type": null, "nullable": false, "collection": false }, { "name": "StartDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "EndDate", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/expenses": { "get": { "operationId": "aurax-bff-redirect-get-expenses-list", "tags": [ "expenses" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-expenses-list", "description": "Request and response fields are declared on the routing target `get-expenses-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a collection.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-expenses-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "expenses", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-expenses-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Filter", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "ExpenseDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "OrganizationId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CustomerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ExpenseCalculationId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ExpenseItemId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "TransactionAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "ExpenseAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "TaxAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "TotalExpenseAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "TotalConfirmedExpenseAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExpenseStatus", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CreatedDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "TransactionDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "ExpenseAccounts", "declared_type": "List", "nullable": false, "collection": true }, { "name": "ExpenseInstallments", "declared_type": "List", "nullable": false, "collection": true }, { "name": "ExpenseRuleMaps", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/expenses/{id}": { "get": { "operationId": "aurax-bff-redirect-get-expense-by-id", "tags": [ "expenses" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-expense-by-id", "description": "Request and response fields are declared on the routing target `get-expense-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "expenseId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-expense-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "expenses/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ExpenseDto", "payload": "ExpenseDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "OrganizationId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CustomerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ExpenseCalculationId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ExpenseItemId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "TransactionAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "ExpenseAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "TaxAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "TotalExpenseAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "TotalConfirmedExpenseAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExpenseStatus", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CreatedDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "TransactionDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "ExpenseAccounts", "declared_type": "List", "nullable": false, "collection": true }, { "name": "ExpenseInstallments", "declared_type": "List", "nullable": false, "collection": true }, { "name": "ExpenseRuleMaps", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/external-service-definitions": { "get": { "operationId": "aurax-bff-redirect-get-external-service-definition-query", "tags": [ "external-service-definitions" ], "summary": "aurax-bff-redirect-get-external-service-definition-query", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-external-service-definition-query", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "external-service-definitions", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/external-service-logs": { "get": { "operationId": "aurax-bff-redirect-get-external-service-log-list", "tags": [ "external-service-logs" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-external-service-log-list", "description": "Request and response fields are declared on the routing target `get-external-service-log-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. It returns a page of records under `data`, with `total` carrying the unpaged count — but the record's fields are not declared.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-external-service-log-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "external-service-logs", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-external-service-log-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "The repository declares `ExternalServiceLogDto` 3 times and nothing in the route expression says which one. No structure is published rather than one picked at random.", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "ExternalServiceLogDto" } } }, "/external-service-logs/{id}": { "get": { "operationId": "aurax-bff-redirect-get-external-service-log-by-id", "tags": [ "external-service-logs" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-external-service-log-by-id", "description": "Request and response fields are declared on the routing target `get-external-service-log-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "localizationId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-external-service-log-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "external-service-logs/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "The repository declares `ExternalServiceLogDto` 3 times and nothing in the route expression says which one. No structure is published rather than one picked at random.", "declared_type": "ExternalServiceLogDto", "payload": "ExternalServiceLogDto" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_INTGRTN_71", "status": 400, "message": null, "message_available": false, "constant_name": "EXTERNAL_SERVICE_LOG_NOT_FOUND" } ] } } }, "/external-services": { "get": { "operationId": "aurax-bff-redirect-get-external-service-definition-list", "tags": [ "external-services" ], "summary": "aurax-bff-redirect-get-external-service-definition-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-external-service-definition-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "external-services", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "ExternalServiceDefinitionDto", "collection": true, "members": [ { "name": "ServiceDefinitionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Url", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AuthType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "AuthData", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AuthExpirePeriod", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "TimeoutDuration", "declared_type": "long?", "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-external-service-definition-list", "target_dapr_app_id": "integration-service", "target_route": "external-services", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-integration-service-create-ui-bpm", "tags": [ "external-services" ], "summary": "aurax-bff-redirect-integration-service-create-ui-bpm", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-integration-service-create-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "external-services", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "ServiceDefinitionId", "declared_type": null, "nullable": false, "collection": false }, { "name": "Url", "declared_type": null, "nullable": false, "collection": false }, { "name": "AuthType", "declared_type": null, "nullable": true, "collection": false }, { "name": "AuthData", "declared_type": null, "nullable": false, "collection": false }, { "name": "AuthExpirePeriod", "declared_type": null, "nullable": true, "collection": false }, { "name": "TimeoutDuration", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/external-services/by-service-definition-id/{serviceDefinitionId}": { "get": { "operationId": "aurax-bff-redirect-get-external-service-definition-by-service-definition-id", "tags": [ "external-services" ], "summary": "aurax-bff-redirect-get-external-service-definition-by-service-definition-id", "parameters": [ { "name": "serviceDefinitionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-external-service-definition-by-service-definition-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "external-services/by-service-definition-id/{serviceDefinitionId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "ServiceDefinitionId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ExternalServiceDefinitionDto", "payload": "ExternalServiceDefinitionDto", "collection": false, "members": [ { "name": "ServiceDefinitionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Url", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AuthType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "AuthData", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AuthExpirePeriod", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "TimeoutDuration", "declared_type": "long?", "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-external-service-definition-by-service-definition-id", "target_dapr_app_id": "integration-service", "target_route": "external-services/by-service-definition-id/{serviceDefinitionId}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_INTGRTN_26", "status": 400, "message": { "ar": "تعريف الخدمة غير موجود", "en": "Service definition cannot be found", "tr": "servis tanımı bulunamadı" }, "message_available": true, "constant_name": "EXTERNAL_SERVICE_DEFINITION_NOT_FOUND" } ] } } }, "/external-services/{id}": { "delete": { "operationId": "aurax-bff-redirect-integration-service-delete-ui-bpm", "tags": [ "external-services" ], "summary": "aurax-bff-redirect-integration-service-delete-ui-bpm", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-integration-service-delete-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "external-services/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "get": { "operationId": "aurax-bff-redirect-get-external-service-definition-by-id", "tags": [ "external-services" ], "summary": "aurax-bff-redirect-get-external-service-definition-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-external-service-definition-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "external-services/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ExternalServiceDefinitionDto", "payload": "ExternalServiceDefinitionDto", "collection": false, "members": [ { "name": "ServiceDefinitionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Url", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AuthType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "AuthData", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AuthExpirePeriod", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "TimeoutDuration", "declared_type": "long?", "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-external-service-definition-by-id", "target_dapr_app_id": "integration-service", "target_route": "external-services/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_INTGRTN_26", "status": 400, "message": { "ar": "تعريف الخدمة غير موجود", "en": "Service definition cannot be found", "tr": "servis tanımı bulunamadı" }, "message_available": true, "constant_name": "EXTERNAL_SERVICE_DEFINITION_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-integration-service-edit-ui-bpm", "tags": [ "external-services" ], "summary": "aurax-bff-redirect-integration-service-edit-ui-bpm", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-integration-service-edit-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "external-services/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "ServiceDefinitionId", "declared_type": null, "nullable": true, "collection": false }, { "name": "Url", "declared_type": null, "nullable": false, "collection": false }, { "name": "AuthType", "declared_type": null, "nullable": true, "collection": false }, { "name": "AuthData", "declared_type": null, "nullable": false, "collection": false }, { "name": "AuthExpirePeriod", "declared_type": null, "nullable": true, "collection": false }, { "name": "TimeoutDuration", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/external-vendors": { "get": { "operationId": "aurax-bff-redirect-get-vendor-external-list", "tags": [ "external-vendors" ], "summary": "aurax-bff-redirect-get-vendor-external-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-vendor-external-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "external-vendors", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "VendorExternalDto", "collection": true, "members": [ { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "VendorExternalType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "VendorExternalNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "MarketPaymentType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "TransferType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Citizenid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SellerName", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-vendor-external-list", "target_dapr_app_id": "loan-service", "target_route": "external-vendors", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-external-vendor-ui-bpmn", "tags": [ "external-vendors" ], "summary": "aurax-bff-redirect-create-external-vendor-ui-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-external-vendor-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "external-vendors", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CustomerId", "declared_type": null, "nullable": true, "collection": false }, { "name": "VendorExternalType", "declared_type": null, "nullable": false, "collection": false }, { "name": "MarketPaymentType", "declared_type": null, "nullable": true, "collection": false }, { "name": "TransferType", "declared_type": null, "nullable": true, "collection": false }, { "name": "Citizenid", "declared_type": null, "nullable": false, "collection": false }, { "name": "SellerName", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/external-vendors/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-external-vendor", "tags": [ "external-vendors" ], "summary": "aurax-bff-redirect-delete-external-vendor", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-external-vendor", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "external-vendors/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "get": { "operationId": "aurax-bff-redirect-get-vendor-external-details-by-id", "tags": [ "external-vendors" ], "summary": "aurax-bff-redirect-get-vendor-external-details-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-vendor-external-details-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "external-vendors/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "VendorExternalDetailsDto", "payload": "VendorExternalDetailsDto", "collection": false, "members": [ { "name": "Accounts", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Distributors", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Poses", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Merchants", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-vendor-external-details-by-id", "target_dapr_app_id": "loan-service", "target_route": "external-vendors/{id}/details", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LOAN_6", "status": 400, "message": { "ar": "لم يتم العثور على بائع خارجي. المعرف: {0}", "en": "External vendor cannot be found. :{0}", "tr": "Dış satıcı bulunamadı. : {0}" }, "message_available": true, "constant_name": "VENDOR_EXTERNAL_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-external-vendor-ui-bpmn", "tags": [ "external-vendors" ], "summary": "aurax-bff-redirect-update-external-vendor-ui-bpmn", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-external-vendor-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "external-vendors/{id}", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/external-vendors/{id}/accounts": { "get": { "operationId": "aurax-bff-redirect-get-vendor-external-account-list", "tags": [ "external-vendors" ], "summary": "aurax-bff-redirect-get-vendor-external-account-list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-vendor-external-account-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "external-vendors/{id}/accounts", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "VendorExternalAccountDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Iban", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BankCode", "declared_type": "int", "nullable": false, "collection": false }, { "name": "CustomerAccountId", "declared_type": "Guid?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-vendor-external-account-list", "target_dapr_app_id": "loan-service", "target_route": "external-vendors/{id}/accounts", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LOAN_6", "status": 400, "message": { "ar": "لم يتم العثور على بائع خارجي. المعرف: {0}", "en": "External vendor cannot be found. :{0}", "tr": "Dış satıcı bulunamadı. : {0}" }, "message_available": true, "constant_name": "VENDOR_EXTERNAL_NOT_FOUND" } ] } }, "post": { "operationId": "aurax-bff-redirect-create-vendor-external-account", "tags": [ "external-vendors" ], "summary": "aurax-bff-redirect-create-vendor-external-account", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-vendor-external-account", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "external-vendors/{id}/accounts", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "forwarded": { "service_code": "create-vendor-external-account", "target_dapr_app_id": "loan-service", "target_route": "external-vendors/{id}/accounts", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LOAN_6", "status": 400, "message": { "ar": "لم يتم العثور على بائع خارجي. المعرف: {0}", "en": "External vendor cannot be found. :{0}", "tr": "Dış satıcı bulunamadı. : {0}" }, "message_available": true, "constant_name": "VENDOR_EXTERNAL_NOT_FOUND" } ] } } }, "/external-vendors/{id}/accounts/{vendorAccountId}": { "delete": { "operationId": "aurax-bff-redirect-delete-vendor-external-account", "tags": [ "external-vendors" ], "summary": "aurax-bff-redirect-delete-vendor-external-account", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "vendorAccountId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-vendor-external-account", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "external-vendors/{id}/accounts/{vendorAccountId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "VendorAccountId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "forwarded": { "service_code": "delete-vendor-external-account", "target_dapr_app_id": "loan-service", "target_route": "external-vendors/{id}/accounts/{vendorAccountId}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LOAN_10", "status": 400, "message": { "ar": "الحساب غير موجود. المعرف: {0}", "en": "Account cannot be found. :{0}", "tr": "Hesap bulunamadı. : {0}" }, "message_available": true, "constant_name": "VENDOR_EXTERNAL_ACCOUNT_NOT_FOUND" }, { "code": "ERR_LOAN_6", "status": 400, "message": { "ar": "لم يتم العثور على بائع خارجي. المعرف: {0}", "en": "External vendor cannot be found. :{0}", "tr": "Dış satıcı bulunamadı. : {0}" }, "message_available": true, "constant_name": "VENDOR_EXTERNAL_NOT_FOUND" } ] } } }, "/external-vendors/{id}/mails": { "get": { "operationId": "aurax-bff-redirect-get-vendor-external-mail-list", "tags": [ "external-vendors" ], "summary": "aurax-bff-redirect-get-vendor-external-mail-list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-vendor-external-mail-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "external-vendors/{id}/mails", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "VendorExternalMailDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Email", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsPriority", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-vendor-external-mail-list", "target_dapr_app_id": "loan-service", "target_route": "external-vendors/{id}/mails", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LOAN_6", "status": 400, "message": { "ar": "لم يتم العثور على بائع خارجي. المعرف: {0}", "en": "External vendor cannot be found. :{0}", "tr": "Dış satıcı bulunamadı. : {0}" }, "message_available": true, "constant_name": "VENDOR_EXTERNAL_NOT_FOUND" } ] } }, "post": { "operationId": "aurax-bff-redirect-create-vendor-external-mail", "tags": [ "external-vendors" ], "summary": "aurax-bff-redirect-create-vendor-external-mail", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-vendor-external-mail", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "external-vendors/{id}/mails", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": true, "collection": false }, { "name": "Email", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsPriority", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "AuraCommandDto", "payload": "AuraCommandDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "create-vendor-external-mail", "target_dapr_app_id": "loan-service", "target_route": "external-vendors/{id}/mails", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LOAN_6", "status": 400, "message": { "ar": "لم يتم العثور على بائع خارجي. المعرف: {0}", "en": "External vendor cannot be found. :{0}", "tr": "Dış satıcı bulunamadı. : {0}" }, "message_available": true, "constant_name": "VENDOR_EXTERNAL_NOT_FOUND" } ] } } }, "/external-vendors/{id}/mails/{mailId}": { "delete": { "operationId": "aurax-bff-redirect-delete-vendor-external-mail", "tags": [ "external-vendors" ], "summary": "aurax-bff-redirect-delete-vendor-external-mail", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "mailId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-vendor-external-mail", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "external-vendors/{id}/mails/{mailId}", "x-aura-request-contract": { "state": "no-members" }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "forwarded": { "service_code": "delete-vendor-external-mail", "target_dapr_app_id": "loan-service", "target_route": "external-vendors/{id}/mails/{mailId}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/external-vendors/{id}/phones": { "get": { "operationId": "aurax-bff-redirect-get-vendor-external-phone-list", "tags": [ "external-vendors" ], "summary": "aurax-bff-redirect-get-vendor-external-phone-list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-vendor-external-phone-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "external-vendors/{id}/phones", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "VendorExternalPhoneDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "PhoneNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsPriority", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-vendor-external-phone-list", "target_dapr_app_id": "loan-service", "target_route": "external-vendors/{id}/phones", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LOAN_6", "status": 400, "message": { "ar": "لم يتم العثور على بائع خارجي. المعرف: {0}", "en": "External vendor cannot be found. :{0}", "tr": "Dış satıcı bulunamadı. : {0}" }, "message_available": true, "constant_name": "VENDOR_EXTERNAL_NOT_FOUND" } ] } }, "post": { "operationId": "aurax-bff-redirect-create-vendor-external-phone", "tags": [ "external-vendors" ], "summary": "aurax-bff-redirect-create-vendor-external-phone", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-vendor-external-phone", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "external-vendors/{id}/phones", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": true, "collection": false }, { "name": "PhoneNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsPriority", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "AuraCommandDto", "payload": "AuraCommandDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "create-vendor-external-phone", "target_dapr_app_id": "loan-service", "target_route": "external-vendors/{id}/phones", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LOAN_6", "status": 400, "message": { "ar": "لم يتم العثور على بائع خارجي. المعرف: {0}", "en": "External vendor cannot be found. :{0}", "tr": "Dış satıcı bulunamadı. : {0}" }, "message_available": true, "constant_name": "VENDOR_EXTERNAL_NOT_FOUND" } ] } } }, "/external-vendors/{id}/status": { "put": { "operationId": "aurax-bff-redirect-update-vendor-external-status", "tags": [ "external-vendors" ], "summary": "aurax-bff-redirect-update-vendor-external-status", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-vendor-external-status", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "external-vendors/{id}/status", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "forwarded": { "service_code": "update-vendor-external-status", "target_dapr_app_id": "loan-service", "target_route": "external-vendors/{id}/status", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LOAN_6", "status": 400, "message": { "ar": "لم يتم العثور على بائع خارجي. المعرف: {0}", "en": "External vendor cannot be found. :{0}", "tr": "Dış satıcı bulunamadı. : {0}" }, "message_available": true, "constant_name": "VENDOR_EXTERNAL_NOT_FOUND" } ] } } }, "/fields": { "get": { "operationId": "aurax-bff-redirect-get-field-definition-list", "tags": [ "fields" ], "summary": "aurax-bff-redirect-get-field-definition-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-field-definition-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "fields", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "FieldDefinitionDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "BaseFieldId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DataType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "IsArray", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "IsMaskable", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "IsEncrypted", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "ParameterId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ParameterDomainId", "declared_type": "Guid?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-field-definition-list", "target_dapr_app_id": "core-service", "target_route": "fields", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-field-definition", "tags": [ "fields" ], "summary": "aurax-bff-redirect-create-field-definition", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-field-definition", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "fields", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "BaseFieldId", "declared_type": null, "nullable": true, "collection": false }, { "name": "Code", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "DataType", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsEncrypted", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsArray", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsMaskable", "declared_type": null, "nullable": true, "collection": false }, { "name": "ParameterId", "declared_type": null, "nullable": true, "collection": false }, { "name": "ParameterDomainId", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "command-id", "note": "The route returns `AuraCommandDto`, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, `Id`, of type `Guid`. A caller gets a JSON OBJECT with one field, not a bare value. The field is `id` on the wire.", "declared_type": "AuraCommandDto", "envelopes": [ "AuraCommandDto" ], "payload": "Guid", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false, "wire_name": "id", "wire_name_basis": "framework-naming-policy" } ], "naming": "Member names are the service's declaration names.", "synthesized": true, "forwarded": { "service_code": "create-field-definition", "target_dapr_app_id": "core-service", "target_route": "fields", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_CORE_129", "status": 400, "message": { "ar": "لا يمكن أن يكون parameterDomainId فارغًا.", "en": "Parameter domain cannot be left blank.", "tr": "Parametre etki alanı boş olamaz." }, "message_available": true, "constant_name": "PARAMETER_DOMAIN_ID_CANNOT_BE_NOT_NULL" }, { "code": "ERR_CORE_130", "status": 400, "message": { "ar": "لا يمكن أن يكون parameterId فارغًا.", "en": "Parameter cannot be left blank.", "tr": "Parametre boş olamaz." }, "message_available": true, "constant_name": "PARAMETER_ID_CANNOT_BE_NOT_NULL" }, { "code": "ERR_CORE_148", "status": 400, "message": { "ar": "يمكن فقط حقول نوع السلسلة أن تكون قابلة للقناع.", "en": "Only string type fields can be maskable.", "tr": "Sadece string tipindeki field tanımları maskelenebilir." }, "message_available": true, "constant_name": "IS_MASKABLE_MUST_BE_USE_WITH_STRING" }, { "code": "ERR_CORE_149", "status": 400, "message": { "ar": "رمز الحقل غير بصيغة صحيحة", "en": "Field Code is not in correct format", "tr": "Alan Kodu doğru formatta değil." }, "message_available": true, "constant_name": "FIELD_CODE_NOT_CORRECT_FORMAT" }, { "code": "ERR_CORE_24", "status": 400, "message": { "ar": "لا يمكن لحقول الرمز أن تحتوي على مسافة.", "en": "Code field cannot contain space.", "tr": "Kod alanı boşluk içeremez." }, "message_available": true, "constant_name": "CODE_FIELD_CANNOT_CONTAIN_SPACE" }, { "code": "ERR_CORE_61", "status": 400, "message": { "ar": "هناك حقل موجود بالفعل بهذا الرمز.", "en": "There is already a field with this code.", "tr": "Bu koda sahip bir alan zaten var." }, "message_available": true, "constant_name": "FIELD_DEFINITION_CODE_ALREADY_EXISTS" }, { "code": "ERR_CORE_62", "status": 400, "message": { "ar": "لم يتم العثور على معرف الحقل الأساسي.", "en": "Base field cannot be found.", "tr": "Temel alan bulunamadı." }, "message_available": true, "constant_name": "BASE_FIELD_DEFINITION_MUST_BE_NOT_NULL" } ] } } }, "/fields/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-field-definition", "tags": [ "fields" ], "summary": "aurax-bff-redirect-delete-field-definition", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-field-definition", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "fields/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "declared_type": "Unit", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "payload": "Unit", "forwarded": { "service_code": "delete-field-definition", "target_dapr_app_id": "core-service", "target_route": "fields/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_CORE_138", "status": 400, "message": { "ar": "هذا الحقل يُعرف بأنه الحقل الأساسي", "en": "This field is defined as base field", "tr": "Bu alan temel alan olarak tanımlanır" }, "message_available": true, "constant_name": "THIS_RECORD_IS_DEFINED_AS_BASE" }, { "code": "ERR_CORE_66", "status": 400, "message": { "ar": "لم يتم العثور على معرّف الحقل.", "en": "Field cannot be found.", "tr": "Alan bulunamadı." }, "message_available": true, "constant_name": "FIELD_ID_IS_NOT_FOUND" } ] } }, "get": { "operationId": "aurax-bff-redirect-get-field-definition-by-id", "tags": [ "fields" ], "summary": "aurax-bff-redirect-get-field-definition-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-field-definition-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "fields/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "FieldDefinitionDto", "payload": "FieldDefinitionDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "BaseFieldId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DataType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "IsArray", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "IsMaskable", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "IsEncrypted", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "ParameterId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ParameterDomainId", "declared_type": "Guid?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-field-definition-by-id", "target_dapr_app_id": "core-service", "target_route": "fields/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_CORE_66", "status": 400, "message": { "ar": "لم يتم العثور على معرّف الحقل.", "en": "Field cannot be found.", "tr": "Alan bulunamadı." }, "message_available": true, "constant_name": "FIELD_ID_IS_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-field-definition", "tags": [ "fields" ], "summary": "aurax-bff-redirect-update-field-definition", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-field-definition", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "fields/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "BaseFieldId", "declared_type": null, "nullable": true, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "DataType", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsEncrypted", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsArray", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsMaskable", "declared_type": null, "nullable": true, "collection": false }, { "name": "ParameterId", "declared_type": null, "nullable": true, "collection": false }, { "name": "ParameterDomainId", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "declared_type": "Unit", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "payload": "Unit", "forwarded": { "service_code": "update-field-definition", "target_dapr_app_id": "core-service", "target_route": "fields/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_CORE_129", "status": 400, "message": { "ar": "لا يمكن أن يكون parameterDomainId فارغًا.", "en": "Parameter domain cannot be left blank.", "tr": "Parametre etki alanı boş olamaz." }, "message_available": true, "constant_name": "PARAMETER_DOMAIN_ID_CANNOT_BE_NOT_NULL" }, { "code": "ERR_CORE_130", "status": 400, "message": { "ar": "لا يمكن أن يكون parameterId فارغًا.", "en": "Parameter cannot be left blank.", "tr": "Parametre boş olamaz." }, "message_available": true, "constant_name": "PARAMETER_ID_CANNOT_BE_NOT_NULL" }, { "code": "ERR_CORE_148", "status": 400, "message": { "ar": "يمكن فقط حقول نوع السلسلة أن تكون قابلة للقناع.", "en": "Only string type fields can be maskable.", "tr": "Sadece string tipindeki field tanımları maskelenebilir." }, "message_available": true, "constant_name": "IS_MASKABLE_MUST_BE_USE_WITH_STRING" }, { "code": "ERR_CORE_54", "status": 400, "message": { "ar": "لا يمكن تعريف المعرف كمعرف parent.", "en": "Cannot define id as parentId.", "tr": "Bu kimliği ana kimlik olarak tanımlayamazsınız." }, "message_available": true, "constant_name": "CANNOT_DEFINE_ID_AS_BASEID" }, { "code": "ERR_CORE_62", "status": 400, "message": { "ar": "لم يتم العثور على معرف الحقل الأساسي.", "en": "Base field cannot be found.", "tr": "Temel alan bulunamadı." }, "message_available": true, "constant_name": "BASE_FIELD_DEFINITION_MUST_BE_NOT_NULL" }, { "code": "ERR_CORE_66", "status": 400, "message": { "ar": "لم يتم العثور على معرّف الحقل.", "en": "Field cannot be found.", "tr": "Alan bulunamadı." }, "message_available": true, "constant_name": "FIELD_ID_IS_NOT_FOUND" } ] } } }, "/file-storages": { "get": { "operationId": "aurax-bff-redirect-get-file-storage-list", "tags": [ "file-storages" ], "summary": "aurax-bff-redirect-get-file-storage-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-file-storage-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "file-storages", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "FileStorageDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ProtocolType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ConnectionString", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-file-storage-list", "target_dapr_app_id": "integration-service", "target_route": "file-storages", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-file-storage", "tags": [ "file-storages" ], "summary": "aurax-bff-redirect-create-file-storage", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-file-storage", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "file-storages", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "ProtocolType", "declared_type": null, "nullable": true, "collection": false }, { "name": "ConnectionString", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "command-id", "note": "The route returns `AuraCommandDto`, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, `Id`, of type `Guid`. A caller gets a JSON OBJECT with one field, not a bare value. The field is `id` on the wire.", "declared_type": "AuraCommandDto", "envelopes": [ "AuraCommandDto" ], "payload": "Guid", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false, "wire_name": "id", "wire_name_basis": "framework-naming-policy" } ], "naming": "Member names are the service's declaration names.", "synthesized": true, "forwarded": { "service_code": "create-file-storage", "target_dapr_app_id": "integration-service", "target_route": "file-storages", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_FILE_1", "status": 400, "message": { "ar": "هناك بالفعل تخزين ملف بهذا الاسم", "en": "There is already file storage with this name", "tr": "Bu isimde zaten bir dosya depolama alanı var" }, "message_available": true, "constant_name": "THERE_IS_ALREADY_FILE_STORAGE_WITH_THIS_NAME" } ] } } }, "/file-storages/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-file-storage", "tags": [ "file-storages" ], "summary": "aurax-bff-redirect-delete-file-storage", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-file-storage", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "file-storages/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "forwarded": { "service_code": "delete-file-storage", "target_dapr_app_id": "integration-service", "target_route": "file-storages/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_FILE_2", "status": 400, "message": { "ar": "لم يتم العثور على معرف تخزين الملف", "en": "File storage ID is not found", "tr": "Dosya depolama ID bulunamadı" }, "message_available": true, "constant_name": "FILE_STORAGE_ID_IS_NOT_FOUND" } ] } }, "get": { "operationId": "aurax-bff-redirect-get-file-storage-by-id", "tags": [ "file-storages" ], "summary": "aurax-bff-redirect-get-file-storage-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-file-storage-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "file-storages/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "FileStorageDto", "payload": "FileStorageDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ProtocolType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ConnectionString", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-file-storage-by-id", "target_dapr_app_id": "integration-service", "target_route": "file-storages/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_FILE_2", "status": 400, "message": { "ar": "لم يتم العثور على معرف تخزين الملف", "en": "File storage ID is not found", "tr": "Dosya depolama ID bulunamadı" }, "message_available": true, "constant_name": "FILE_STORAGE_ID_IS_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-file-storage", "tags": [ "file-storages" ], "summary": "aurax-bff-redirect-update-file-storage", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-file-storage", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "file-storages/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "ProtocolType", "declared_type": null, "nullable": true, "collection": false }, { "name": "ConnectionString", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "forwarded": { "service_code": "update-file-storage", "target_dapr_app_id": "integration-service", "target_route": "file-storages/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_FILE_2", "status": 400, "message": { "ar": "لم يتم العثور على معرف تخزين الملف", "en": "File storage ID is not found", "tr": "Dosya depolama ID bulunamadı" }, "message_available": true, "constant_name": "FILE_STORAGE_ID_IS_NOT_FOUND" } ] } } }, "/file-transfers": { "get": { "operationId": "aurax-bff-redirect-get-file-transfer-list", "tags": [ "file-transfers" ], "summary": "aurax-bff-redirect-get-file-transfer-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-file-transfer-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "file-transfers", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "FileTransferDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SourceFileStorageId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "SourcePath", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SourcePathWildcard", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DestinationFileStorageId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "DestinationPath", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsZip", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "CanArchive", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "ArchiveFileStorageId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ArchivePath", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OverwriteType", "declared_type": "int?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-file-transfer-list", "target_dapr_app_id": "integration-service", "target_route": "file-transfers", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-file-transfer", "tags": [ "file-transfers" ], "summary": "aurax-bff-redirect-create-file-transfer", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-file-transfer", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "file-transfers", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Code", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "SourceFileStorageId", "declared_type": null, "nullable": true, "collection": false }, { "name": "SourcePath", "declared_type": null, "nullable": false, "collection": false }, { "name": "SourcePathWildcard", "declared_type": null, "nullable": false, "collection": false }, { "name": "DestinationFileStorageId", "declared_type": null, "nullable": true, "collection": false }, { "name": "DestinationPath", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsZip", "declared_type": null, "nullable": true, "collection": false }, { "name": "CanArchive", "declared_type": null, "nullable": true, "collection": false }, { "name": "ArchiveFileStorageId", "declared_type": null, "nullable": true, "collection": false }, { "name": "ArchivePath", "declared_type": null, "nullable": false, "collection": false }, { "name": "OverwriteType", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "command-id", "note": "The route returns `AuraCommandDto`, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, `Id`, of type `Guid`. A caller gets a JSON OBJECT with one field, not a bare value. The field is `id` on the wire.", "declared_type": "AuraCommandDto", "envelopes": [ "AuraCommandDto" ], "payload": "Guid", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false, "wire_name": "id", "wire_name_basis": "framework-naming-policy" } ], "naming": "Member names are the service's declaration names.", "synthesized": true, "forwarded": { "service_code": "create-file-transfer", "target_dapr_app_id": "integration-service", "target_route": "file-transfers", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/file-transfers/by-code/{code}/execute": { "post": { "operationId": "aurax-bff-redirect-execute-file-transfer", "tags": [ "file-transfers" ], "summary": "aurax-bff-redirect-execute-file-transfer", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-execute-file-transfer", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "file-transfers/by-code/{code}/execute", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Code", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsFolderZip", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "`FileData` is not among the C# declarations parsed from this repository. The resolver checks this repository first, then permits a lookup in `aura/framework` or `aura/kernel` only when this repository declares the matching 0.2-line PackageReference. This unresolved verdict means neither licensed lookup produced exactly one parsed declaration. The view does not expose whether that was because no eligible package proof exists or because the entitled platform source does not declare the name, so this page does not guess between them. It is a dependency-boundary gap in what this portal can resolve, not evidence that the service returns no body.", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "FileData", "forwarded": { "service_code": "execute-file-transfer", "target_dapr_app_id": "integration-service", "target_route": "file-transfers/by-code/{code}/execute", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_FILE_15", "status": 400, "message": { "ar": "رمز نقل الملف غير موجود", "en": "File transfer code is not found", "tr": "Dosya transfer kod bulunamadı" }, "message_available": true, "constant_name": "FILE_TRANSFER_CODE_IS_NOT_FOUND" }, { "code": "ERR_FILE_19", "status": 400, "message": { "ar": "يوجد بالفعل ملف بهذا الاسم", "en": "There is already exist file with this name", "tr": "Bu isimle bir dosya zaten mevcut" }, "message_available": true, "constant_name": "THERE_IS_ALREADY_EXIST_FILE_WITH_THIS_NAME" }, { "code": "ERR_FILE_20", "status": 400, "message": { "ar": "ملفات غير موجودة", "en": "Files not found", "tr": "Dosyalar bulunamadı" }, "message_available": true, "constant_name": "FILES_NOT_FOUND" }, { "code": "ERR_FILE_6", "status": 400, "message": { "ar": "يجب ألا يكون معرف تخزين ملف الأرشيف فارغًا", "en": "Archive file storage ID must be not null", "tr": "Arşiv dosya depolama ID boş olmamalı" }, "message_available": true, "constant_name": "ARCHIEVE_FILE_STORAGE_ID_MUST_BE_NOT_NULL" }, { "code": "ERR_FILE_8", "status": 400, "message": { "ar": "معرف تخزين ملف الوجهة يجب ألا يكون فارغًا", "en": "Destination file storage ID must be not null", "tr": "Hedef dosya depolama ID boş olmamalı" }, "message_available": true, "constant_name": "DESTINATION_FILE_STORAGE_ID_MUST_BE_NOT_NULL" } ] } } }, "/file-transfers/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-file-transfer", "tags": [ "file-transfers" ], "summary": "aurax-bff-redirect-delete-file-transfer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-file-transfer", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "file-transfers/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "forwarded": { "service_code": "delete-file-transfer", "target_dapr_app_id": "integration-service", "target_route": "file-transfers/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_FILE_14", "status": 400, "message": { "ar": "لم يتم العثور على معرف نقل الملف", "en": "File transfer ID is not found", "tr": "Dosya transfer ID bulunamadı" }, "message_available": true, "constant_name": "FILE_TRANSFER_ID_IS_NOT_FOUND" } ] } }, "get": { "operationId": "aurax-bff-redirect-get-file-transfer-by-id", "tags": [ "file-transfers" ], "summary": "aurax-bff-redirect-get-file-transfer-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-file-transfer-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "file-transfers/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "FileTransferDto", "payload": "FileTransferDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SourceFileStorageId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "SourcePath", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SourcePathWildcard", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DestinationFileStorageId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "DestinationPath", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsZip", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "CanArchive", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "ArchiveFileStorageId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ArchivePath", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OverwriteType", "declared_type": "int?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-file-transfer-by-id", "target_dapr_app_id": "integration-service", "target_route": "file-transfers/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_FILE_14", "status": 400, "message": { "ar": "لم يتم العثور على معرف نقل الملف", "en": "File transfer ID is not found", "tr": "Dosya transfer ID bulunamadı" }, "message_available": true, "constant_name": "FILE_TRANSFER_ID_IS_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-file-transfer", "tags": [ "file-transfers" ], "summary": "aurax-bff-redirect-update-file-transfer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-file-transfer", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "file-transfers/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Code", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "SourceFileStorageId", "declared_type": null, "nullable": true, "collection": false }, { "name": "SourcePath", "declared_type": null, "nullable": false, "collection": false }, { "name": "SourcePathWildcard", "declared_type": null, "nullable": false, "collection": false }, { "name": "DestinationFileStorageId", "declared_type": null, "nullable": true, "collection": false }, { "name": "DestinationPath", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsZip", "declared_type": null, "nullable": true, "collection": false }, { "name": "CanArchive", "declared_type": null, "nullable": true, "collection": false }, { "name": "ArchiveFileStorageId", "declared_type": null, "nullable": true, "collection": false }, { "name": "ArchivePath", "declared_type": null, "nullable": false, "collection": false }, { "name": "OverwriteType", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "declared_type": "Unit", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "payload": "Unit", "forwarded": { "service_code": "update-file-transfer", "target_dapr_app_id": "integration-service", "target_route": "file-transfers/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_FILE_14", "status": 400, "message": { "ar": "لم يتم العثور على معرف نقل الملف", "en": "File transfer ID is not found", "tr": "Dosya transfer ID bulunamadı" }, "message_available": true, "constant_name": "FILE_TRANSFER_ID_IS_NOT_FOUND" } ] } } }, "/file-transfers/{id}/histories": { "get": { "operationId": "aurax-bff-redirect-get-file-transfer-history-list", "tags": [ "file-transfers" ], "summary": "aurax-bff-redirect-get-file-transfer-history-list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-file-transfer-history-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "file-transfers/{id}/histories", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "FileTransferHistoryDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "BeginDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "CompletedDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "FileName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FileSize", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Status", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ErrorDescription", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-file-transfer-history-list", "target_dapr_app_id": "integration-service", "target_route": "file-transfers/{id}/histories", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/financial-statement-templates": { "get": { "operationId": "aurax-bff-redirect-get-statement-template-list", "tags": [ "financial-statement-templates" ], "summary": "aurax-bff-redirect-get-statement-template-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-statement-template-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "financial-statement-templates", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "StatementTemplateDto", "collection": true, "members": [ { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-statement-template-list", "target_dapr_app_id": "accounting-service", "target_route": "financial-statement-templates", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-financial-statement-template-with-item-and-detail-bpmn", "tags": [ "financial-statement-templates" ], "summary": "aurax-bff-redirect-create-financial-statement-template-with-item-and-detail-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-financial-statement-template-with-item-and-detail-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "financial-statement-templates", "x-aura-request-contract": { "state": "no-members" }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "put": { "operationId": "aurax-bff-redirect-update-financial-statement-template-with-item-and-detail-bpmn", "tags": [ "financial-statement-templates" ], "summary": "aurax-bff-redirect-update-financial-statement-template-with-item-and-detail-bpmn", "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-financial-statement-template-with-item-and-detail-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "financial-statement-templates", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/financial-statement-templates/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-statement-template-bpmn", "tags": [ "financial-statement-templates" ], "summary": "aurax-bff-redirect-delete-statement-template-bpmn", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-statement-template-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "financial-statement-templates/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "get": { "operationId": "aurax-bff-redirect-get-statement-template-by-id", "tags": [ "financial-statement-templates" ], "summary": "aurax-bff-redirect-get-statement-template-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-statement-template-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "financial-statement-templates/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "StatementTemplateDto", "payload": "StatementTemplateDto", "collection": false, "members": [ { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-statement-template-by-id", "target_dapr_app_id": "accounting-service", "target_route": "financial-statement-templates/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_221", "status": 400, "message": { "ar": "لم يتم العثور على قالب البيان المالي بالمعرّف المُعطى: '{0}'.", "en": "Financial statement template is not found with the given id: '{0}'.", "tr": "Belirtilen kimliğe sahip mali tablo şablonu bulunamadı: '{0}'." }, "message_available": true, "constant_name": "FINANCIAL_STATEMENT_TEMPLATE_IS_NOT_FOUND" } ] } } }, "/financial-statement-templates/{id}/items": { "get": { "operationId": "aurax-bff-redirect-get-statement-template-item-and-details-by-template-id", "tags": [ "financial-statement-templates" ], "summary": "aurax-bff-redirect-get-statement-template-item-and-details-by-template-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-statement-template-item-and-details-by-template-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "financial-statement-templates/{id}/items", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "StatementTemplateItemDto", "collection": true, "members": [ { "name": "FinancialStatementTemplateItemId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsSummary", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "IsAbsolute", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "CalculationResource", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ParentFinancialStatementTemplateItemId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Details", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-statement-template-item-and-details-by-template-id", "target_dapr_app_id": "accounting-service", "target_route": "financial-statement-templates/{id}/items", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_221", "status": 400, "message": { "ar": "لم يتم العثور على قالب البيان المالي بالمعرّف المُعطى: '{0}'.", "en": "Financial statement template is not found with the given id: '{0}'.", "tr": "Belirtilen kimliğe sahip mali tablo şablonu bulunamadı: '{0}'." }, "message_available": true, "constant_name": "FINANCIAL_STATEMENT_TEMPLATE_IS_NOT_FOUND" } ] } } }, "/financial-statement-templates/{id}/items/{financialStatementTemplateItemId}/details": { "get": { "operationId": "aurax-bff-redirect-get-statement-template-item-detail-by-item-id", "tags": [ "financial-statement-templates" ], "summary": "aurax-bff-redirect-get-statement-template-item-detail-by-item-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "financialStatementTemplateItemId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-statement-template-item-detail-by-item-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "financial-statement-templates/{id}/items/{financialStatementTemplateItemId}/details", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "StatementTemplateItemDetailDto", "collection": true, "members": [ { "name": "FinancialStatementTemplateDetailId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CalcLedgerCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CalcFinancialStatementTemplateItemId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "EffectType", "declared_type": "int?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-statement-template-item-detail-by-item-id", "target_dapr_app_id": "accounting-service", "target_route": "financial-statement-templates/{id}/items/{financialStatementTemplateItemId}/details", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_221", "status": 400, "message": { "ar": "لم يتم العثور على قالب البيان المالي بالمعرّف المُعطى: '{0}'.", "en": "Financial statement template is not found with the given id: '{0}'.", "tr": "Belirtilen kimliğe sahip mali tablo şablonu bulunamadı: '{0}'." }, "message_available": true, "constant_name": "FINANCIAL_STATEMENT_TEMPLATE_IS_NOT_FOUND" }, { "code": "ERR_ACCTNG_224", "status": 400, "message": { "ar": "عنصر واحد أو أكثر في القائمة التالية غير موجود. '{0}'", "en": "One or more items in the following list\nis not found. '{0}'", "tr": "Aşağıdaki listedeki bir veya daha fazla öğe" }, "message_available": true, "constant_name": "FINANCIAL_STATEMENT_TEMPLATE_ITEM_NOT_FOUND" } ] } } }, "/financial-statements": { "get": { "operationId": "aurax-bff-get-financial-statement-list", "tags": [ "financial-statements" ], "summary": "aurax-bff-get-financial-statement-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-get-financial-statement-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "financial-statements", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false }, { "name": "AssignUserCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsWorkflowPool", "declared_type": null, "nullable": false, "collection": false }, { "name": "FinancialStatementTemplateId", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrganizationCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "CurrencyNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExchangeSpreadType", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExchangeRateType", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "PagedResultDto", "envelopes": [ "PagedResultDto" ], "payload": "FinancialStatementDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "FinancialStatementName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReportDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "StatementItems", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." } } }, "/financial-transactions": { "get": { "operationId": "aurax-bff-redirect-get-financial-transaction-list", "tags": [ "financial-transactions" ], "summary": "aurax-bff-redirect-get-financial-transaction-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-financial-transaction-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "financial-transactions", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Filter", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "FinancialTransactionDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DebitLedgerCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DebitLedgerMatrixId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "DebitLedgerMatrixName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DebitLedgerMatrixFieldId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "DebitLedgerMatrixFieldName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CreditLedgerCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CreditLedgerMatrixId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CreditLedgerMatrixName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CreditLedgerMatrixFieldId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CreditLedgerMatrixFieldName", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-financial-transaction-list", "target_dapr_app_id": "accounting-service", "target_route": "financial-transactions", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-financial-transaction-bpmn", "tags": [ "financial-transactions" ], "summary": "aurax-bff-redirect-create-financial-transaction-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-financial-transaction-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "financial-transactions", "x-aura-request-contract": { "state": "no-members" }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/financial-transactions/by-code/{code}": { "get": { "operationId": "aurax-bff-redirect-get-financial-transaction-by-code", "tags": [ "financial-transactions" ], "summary": "aurax-bff-redirect-get-financial-transaction-by-code", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-financial-transaction-by-code", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "financial-transactions/by-code/{code}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Code", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "FinancialTransactionDto", "payload": "FinancialTransactionDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DebitLedgerCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DebitLedgerMatrixId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "DebitLedgerMatrixName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DebitLedgerMatrixFieldId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "DebitLedgerMatrixFieldName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CreditLedgerCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CreditLedgerMatrixId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CreditLedgerMatrixName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CreditLedgerMatrixFieldId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CreditLedgerMatrixFieldName", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-financial-transaction-by-code", "target_dapr_app_id": "accounting-service", "target_route": "financial-transactions/by-code/{code}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/financial-transactions/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-financial-transaction-bpmn", "tags": [ "financial-transactions" ], "summary": "aurax-bff-redirect-delete-financial-transaction-bpmn", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-financial-transaction-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "financial-transactions/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "put": { "operationId": "aurax-bff-redirect-update-financial-transaction-bpmn", "tags": [ "financial-transactions" ], "summary": "aurax-bff-redirect-update-financial-transaction-bpmn", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-financial-transaction-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "financial-transactions/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/fiscal-years": { "get": { "operationId": "aurax-bff-redirect-get-fiscal-year-list", "tags": [ "fiscal-years" ], "summary": "aurax-bff-redirect-get-fiscal-year-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-fiscal-year-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "fiscal-years", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Filter", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "FiscalYearDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "YearStart", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "YearEnd", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "Status", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "YearEndClosingStatus", "declared_type": "int?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-fiscal-year-list", "target_dapr_app_id": "accounting-service", "target_route": "fiscal-years", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/fiscal-years/periods": { "post": { "operationId": "aurax-bff-redirect-create-fiscal-year-and-period-bpmn", "tags": [ "fiscal-years" ], "summary": "aurax-bff-redirect-create-fiscal-year-and-period-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-fiscal-year-and-period-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "fiscal-years/periods", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "put": { "operationId": "aurax-bff-redirect-update-fiscal-periods-status-and-organization-fiscal-period-status-bpmn", "tags": [ "fiscal-years" ], "summary": "aurax-bff-redirect-update-fiscal-periods-status-and-organization-fiscal-period-status-bpmn", "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-fiscal-periods-status-and-organization-fiscal-period-status-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "fiscal-years/periods", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/fiscal-years/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-fiscal-period-and-fiscal-year", "tags": [ "fiscal-years" ], "summary": "aurax-bff-redirect-delete-fiscal-period-and-fiscal-year", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-fiscal-period-and-fiscal-year", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "fiscal-years/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "get": { "operationId": "aurax-bff-redirect-get-fiscal-year-by-id", "tags": [ "fiscal-years" ], "summary": "aurax-bff-redirect-get-fiscal-year-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-fiscal-year-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "fiscal-years/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "FiscalYearDto", "payload": "FiscalYearDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "YearStart", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "YearEnd", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "Status", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "YearEndClosingStatus", "declared_type": "int?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-fiscal-year-by-id", "target_dapr_app_id": "accounting-service", "target_route": "fiscal-years/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_143", "status": 400, "message": { "ar": "السنة المالية غير موجودة بالمعرف المقدم '{0}'.", "en": "Fiscal year is not found with given id '{0}'.", "tr": "Verilen '{0}' kimliğiyle mali yıl bulunamadı." }, "message_available": true, "constant_name": "FISCAL_YEAR_IS_NOT_FOUND" } ] } } }, "/fiscal-years/{id}/periods": { "get": { "operationId": "aurax-bff-redirect-get-fiscal-period-list", "tags": [ "fiscal-years" ], "summary": "aurax-bff-redirect-get-fiscal-period-list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-fiscal-period-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "fiscal-years/{id}/periods", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "FiscalPeriodDto", "collection": true, "members": [ { "name": "FiscalPeriodId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "PeriodStart", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "PeriodEnd", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "OrdinalPosition", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Organizations", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-fiscal-period-list", "target_dapr_app_id": "accounting-service", "target_route": "fiscal-years/{id}/periods", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_143", "status": 400, "message": { "ar": "السنة المالية غير موجودة بالمعرف المقدم '{0}'.", "en": "Fiscal year is not found with given id '{0}'.", "tr": "Verilen '{0}' kimliğiyle mali yıl bulunamadı." }, "message_available": true, "constant_name": "FISCAL_YEAR_IS_NOT_FOUND" } ] } } }, "/follow-send-sms": { "post": { "operationId": "aurax-bff-follow-send-smsfollow-send-sms", "tags": [ "follow-send-sms" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "follow-send-sms", "description": "Invokes the `aurax-bff-follow-send-smsfollow-send-sms` service definition through `POST /follow-send-sms`.\n\nRequest and response fields are declared on the routing target `follow-send-sms`; this entry declares none of its own.", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-follow-send-smsfollow-send-sms", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "follow-send-sms", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/follow-types": { "get": { "operationId": "aurax-bff-redirect-get-follow-type-list", "tags": [ "follow-types" ], "summary": "aurax-bff-redirect-get-follow-type-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-follow-type-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "follow-types", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "FollowTypeDto", "collection": true, "members": [ { "name": "FollowType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MinDayOfDelay", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "MaxDayOfDelay", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsClosedCollection", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "CustomerType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "FollowTypeCode", "declared_type": "int", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-follow-type-list", "target_dapr_app_id": "legal-follow-service", "target_route": "follow-types", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-follow-type-ui-bpmn", "tags": [ "follow-types" ], "summary": "aurax-bff-redirect-create-follow-type-ui-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-follow-type-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "follow-types", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "FollowType", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "MinDayOfDelay", "declared_type": null, "nullable": false, "collection": false }, { "name": "MaxDayOfDelay", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsClosedCollection", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerType", "declared_type": null, "nullable": false, "collection": false }, { "name": "FollowTypeCode", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "put": { "operationId": "aurax-bff-redirect-update-follow-type-ui-bpmn", "tags": [ "follow-types" ], "summary": "aurax-bff-redirect-update-follow-type-ui-bpmn", "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-follow-type-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "follow-types", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/follow-types/{id}/details": { "get": { "operationId": "aurax-bff-redirect-get-follow-type-details-by-id", "tags": [ "follow-types" ], "summary": "aurax-bff-redirect-get-follow-type-details-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-follow-type-details-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "follow-types/{id}/details", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "FollowTypeDetailDto", "payload": "FollowTypeDetailDto", "collection": false, "members": [ { "name": "Provisions", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Notifications", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-follow-type-details-by-id", "target_dapr_app_id": "legal-follow-service", "target_route": "follow-types/{id}/details", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LGLFLLW_4", "status": 400, "message": { "ar": "لا يمكن العثور على نوع المتابعة: {0}", "en": "Follow Type cannot be found. :{0}", "tr": "Takip Türü bulunamıyor. :{0}" }, "message_available": true, "constant_name": "FOLLOWTYPE_NOT_FOUND" } ] } } }, "/foreign-trade/parameters/by-code/{code}/values": { "get": { "operationId": "aurax-bff-redirect-foreign-trade-get-parameters-by-code-values", "tags": [ "foreign-trade" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-foreign-trade-get-parameters-by-code-values", "description": "Request and response fields are declared on the routing target `foreign-trade-get-parameter-value-list-by-parameter-code`; this entry declares none of its own.", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "code" } }, { "name": "includeInactive", "in": "query", "required": false, "schema": { "type": "boolean", "x-aura-field-code": "includeInactive" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 1 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a collection.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-foreign-trade-get-parameters-by-code-values", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "foreign-trade/parameters/by-code/{code}/values", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "ParameterValueDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ParamKey", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Context", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SortOrder", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "Translations", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_PRMTR_12", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_CODE_NOT_FOUND" } ] } } }, "/forms": { "get": { "operationId": "aurax-bff-redirect-aurax-management-get-form-definition-list", "tags": [ "forms" ], "summary": "aurax-bff-redirect-aurax-management-get-form-definition-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-aurax-management-get-form-definition-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "forms", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "BaseFormDefinitionDto", "collection": true, "members": [ { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DomainDefinitionId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "FormType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "MenuDefinitionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ValidationSchema", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UrlPath", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Translations", "declared_type": "IEnumerable", "nullable": false, "collection": true }, { "name": "FormDefinitionServiceMap", "declared_type": "IEnumerable", "nullable": false, "collection": true }, { "name": "FormDynamicContents", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "aurax-management-get-form-definition-list", "target_dapr_app_id": "aurax-management-service", "target_route": "forms", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-aurax-management-create-form-definition", "tags": [ "forms" ], "summary": "aurax-bff-redirect-aurax-management-create-form-definition", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-aurax-management-create-form-definition", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "forms", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/forms/by-code/{code}/details": { "get": { "operationId": "aurax-bff-redirect-aurax-management-get-form-definition-detail-by-code", "tags": [ "forms" ], "summary": "aurax-bff-redirect-aurax-management-get-form-definition-detail-by-code", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-aurax-management-get-form-definition-detail-by-code", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "forms/by-code/{code}/details", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Code", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "FormDefinitionDetailDto", "payload": "FormDefinitionDetailDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DomainDefinitionId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "FormType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "MenuDefinitionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ValidationSchema", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UrlPath", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Translations", "declared_type": "IEnumerable", "nullable": false, "collection": true }, { "name": "FormDefinitionServiceMap", "declared_type": "IEnumerable", "nullable": false, "collection": true }, { "name": "FormActions", "declared_type": "IEnumerable", "nullable": false, "collection": true }, { "name": "FormDynamicContents", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." } } }, "/forms/details": { "get": { "operationId": "aurax-bff-redirect-aurax-management-get-form-definition-detail-list", "tags": [ "forms" ], "summary": "aurax-bff-redirect-aurax-management-get-form-definition-detail-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-aurax-management-get-form-definition-detail-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "forms/details", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false }, { "name": "Path", "declared_type": null, "nullable": false, "collection": false }, { "name": "WithAuthorization", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "List", "envelopes": [ "List" ], "payload": "FormDefinitionDetailDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DomainDefinitionId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "FormType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "MenuDefinitionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ValidationSchema", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UrlPath", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Translations", "declared_type": "IEnumerable", "nullable": false, "collection": true }, { "name": "FormDefinitionServiceMap", "declared_type": "IEnumerable", "nullable": false, "collection": true }, { "name": "FormActions", "declared_type": "IEnumerable", "nullable": false, "collection": true }, { "name": "FormDynamicContents", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_FRMCTL_31", "status": 400, "message": null, "message_available": false, "constant_name": "FORM_DEFINITION_IS_NOT_ACTIVE" } ] } } }, "/forms/{id}": { "delete": { "operationId": "aurax-bff-redirect-aurax-management-delete-form-definition", "tags": [ "forms" ], "summary": "aurax-bff-redirect-aurax-management-delete-form-definition", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-aurax-management-delete-form-definition", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "forms/{id}", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "get": { "operationId": "aurax-bff-redirect-aurax-management-get-form-definition-by-id", "tags": [ "forms" ], "summary": "aurax-bff-redirect-aurax-management-get-form-definition-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-aurax-management-get-form-definition-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "forms/{id}", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "FormDefinitionDto", "payload": "FormDefinitionDto", "collection": false, "members": [ { "name": "FormActions", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "aurax-management-get-form-definition-by-id", "target_dapr_app_id": "aurax-management-service", "target_route": "forms/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_FRMCTL_6", "status": 400, "message": null, "message_available": false, "constant_name": "FORM_DEFINITION_ID_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-aurax-management-update-form-definition", "tags": [ "forms" ], "summary": "aurax-bff-redirect-aurax-management-update-form-definition", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-aurax-management-update-form-definition", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "forms/{id}", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/forms/{id}/details": { "get": { "operationId": "aurax-bff-redirect-aurax-management-get-form-definition-detail-by-id", "tags": [ "forms" ], "summary": "aurax-bff-redirect-aurax-management-get-form-definition-detail-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-aurax-management-get-form-definition-detail-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "forms/{id}/details", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "FormDefinitionDetailDto", "payload": "FormDefinitionDetailDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DomainDefinitionId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "FormType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "MenuDefinitionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ValidationSchema", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UrlPath", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Translations", "declared_type": "IEnumerable", "nullable": false, "collection": true }, { "name": "FormDefinitionServiceMap", "declared_type": "IEnumerable", "nullable": false, "collection": true }, { "name": "FormActions", "declared_type": "IEnumerable", "nullable": false, "collection": true }, { "name": "FormDynamicContents", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." } } }, "/formulas": { "get": { "operationId": "aurax-bff-redirect-get-formula-definition-list", "tags": [ "formulas" ], "summary": "aurax-bff-redirect-get-formula-definition-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-formula-definition-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "formulas", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "FormulaDefinitionDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ResponseFieldId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "FormulaType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "FormulaWorkingType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Formula", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-formula-definition-list", "target_dapr_app_id": "core-service", "target_route": "formulas", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-formula-bpm", "tags": [ "formulas" ], "summary": "aurax-bff-redirect-create-formula-bpm", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-formula-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "formulas", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Code", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "ResponseFieldId", "declared_type": null, "nullable": true, "collection": false }, { "name": "FormulaType", "declared_type": null, "nullable": false, "collection": false }, { "name": "FormulaWorkingType", "declared_type": null, "nullable": false, "collection": false }, { "name": "Formula", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/formulas-details": { "get": { "operationId": "aurax-bff-redirect-get-formula-detail-list", "tags": [ "formulas-details" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-formula-detail-list", "description": "Request and response fields are declared on the routing target `get-formula-detail-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 1 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a collection.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-formula-detail-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "formulas-details", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-formula-detail-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "FormulaDefinitionDetailDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ResponseFieldId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "FormulaType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "FormulaWorkingType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Formula", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "RequestDetails", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/formulas/{formulaDefinitionId}": { "delete": { "operationId": "aurax-bff-redirect-delete-formula-definition", "tags": [ "formulas" ], "summary": "aurax-bff-redirect-delete-formula-definition", "parameters": [ { "name": "formulaDefinitionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only", "x-aura-catalog-parameter-name": "id" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-formula-definition", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "formulas/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "forwarded": { "service_code": "delete-formula-definition", "target_dapr_app_id": "core-service", "target_route": "formulas/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_CORE_70", "status": 400, "message": { "ar": "معرف الصيغة غير موجود.", "en": "Formula cannot be found.", "tr": "Formül bulunamadı." }, "message_available": true, "constant_name": "FORMULA_DEFINITION_ID_IS_NOT_FOUND" } ] }, "x-aura-path-template-merged": { "catalog_template": "/formulas/{id}", "published_template": "/formulas/{formulaDefinitionId}", "renamed": { "id": "formulaDefinitionId" }, "reason": "OpenAPI 3.1 §4.8.8 — paths differing only in template variable names are identical and MUST NOT coexist. A path parameter name is local to the template and positional on the wire, so this rename does not change the request; the catalog names are preserved on each parameter and here." } }, "get": { "operationId": "aurax-bff-redirect-get-formula-definition-by-id", "tags": [ "formulas" ], "summary": "aurax-bff-redirect-get-formula-definition-by-id", "parameters": [ { "name": "formulaDefinitionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only", "x-aura-catalog-parameter-name": "id" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-formula-definition-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "formulas/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "FormulaDefinitionDto", "payload": "FormulaDefinitionDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ResponseFieldId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "FormulaType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "FormulaWorkingType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Formula", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-formula-definition-by-id", "target_dapr_app_id": "core-service", "target_route": "formulas/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_CORE_70", "status": 400, "message": { "ar": "معرف الصيغة غير موجود.", "en": "Formula cannot be found.", "tr": "Formül bulunamadı." }, "message_available": true, "constant_name": "FORMULA_DEFINITION_ID_IS_NOT_FOUND" } ] }, "x-aura-path-template-merged": { "catalog_template": "/formulas/{id}", "published_template": "/formulas/{formulaDefinitionId}", "renamed": { "id": "formulaDefinitionId" }, "reason": "OpenAPI 3.1 §4.8.8 — paths differing only in template variable names are identical and MUST NOT coexist. A path parameter name is local to the template and positional on the wire, so this rename does not change the request; the catalog names are preserved on each parameter and here." } }, "put": { "operationId": "aurax-bff-redirect-update-formula-bpm", "tags": [ "formulas" ], "summary": "aurax-bff-redirect-update-formula-bpm", "parameters": [ { "name": "formulaDefinitionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-formula-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "formulas/{formulaDefinitionId}", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/formulas/{id}/requests": { "get": { "operationId": "aurax-bff-redirect-get-formula-definition-request-list", "tags": [ "formulas" ], "summary": "aurax-bff-redirect-get-formula-definition-request-list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-formula-definition-request-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "formulas/{id}/requests", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "FormulaDefinitionRequestDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FieldId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "DefaultValue", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-formula-definition-request-list", "target_dapr_app_id": "core-service", "target_route": "formulas/{id}/requests", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/get-mail-notifications/detail": { "get": { "operationId": "get-mail-notifications-detail", "tags": [ "get-mail-notifications" ], "summary": "get-mail-notifications-detail", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-mail-notifications-detail", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "get-mail-notifications/detail", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "PagedResultDto", "envelopes": [ "PagedResultDto" ], "payload": "GetMailNotificationDetailDto", "collection": false, "members": [ { "name": "NotificationProviderId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CorrelationId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "IsSuccess", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "DeliveryTime", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "ErrorCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ErrorMessage", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/get-product-list-test-bpmn": { "post": { "operationId": "aurax-bff-get-product-list-test-bpmn", "tags": [ "get-product-list-test-bpmn" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-get-product-list-test-bpmn", "description": "Request and response fields are declared on the routing target `get-product-list-test-bpmn`; this entry declares none of its own.", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-get-product-list-test-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "get-product-list-test-bpmn", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/get-sms-notifications/detail": { "get": { "operationId": "get-sms-notifications-detail", "tags": [ "get-sms-notifications" ], "summary": "get-sms-notifications-detail", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-sms-notifications-detail", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "get-sms-notifications/detail", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "PagedResultDto", "envelopes": [ "PagedResultDto" ], "payload": "GetSmsNotificationDetailDto", "collection": false, "members": [ { "name": "NotificationProviderId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CorrelationId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "IsSuccess", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "DeliveryTime", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "ErrorCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ErrorMessage", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/gl-code-formats": { "delete": { "operationId": "aurax-bff-redirect-delete-gLCode-format-bpmn", "tags": [ "gl-code-formats" ], "summary": "aurax-bff-redirect-delete-gLCode-format-bpmn", "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-gLCode-format-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "gl-code-formats", "x-aura-request-contract": { "state": "no-members" }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "get": { "operationId": "aurax-bff-redirect-get-gLCode-format-list", "tags": [ "gl-code-formats" ], "summary": "aurax-bff-redirect-get-gLCode-format-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-gLCode-format-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "gl-code-formats", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "GLCodeFormatDto", "payload": "GLCodeFormatDto", "collection": false, "members": [ { "name": "SectionSeparator", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GLCodeSections", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-gLCode-format-list", "target_dapr_app_id": "accounting-service", "target_route": "gl-code-formats", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "put": { "operationId": "aurax-bff-redirect-create-update-gLCode-format-bpmn", "tags": [ "gl-code-formats" ], "summary": "aurax-bff-redirect-create-update-gLCode-format-bpmn", "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-update-gLCode-format-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "gl-code-formats", "x-aura-request-contract": { "state": "no-members" }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/gl-code-sections": { "get": { "operationId": "aurax-bff-redirect-get-gLCode-section-list", "tags": [ "gl-code-sections" ], "summary": "aurax-bff-redirect-get-gLCode-section-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-gLCode-section-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "gl-code-sections", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Filter", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "GLCodeSectionListDto", "collection": true, "members": [ { "name": "ParentSectionName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "SectionType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SectionLength", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsMainParent", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "IsMandatory", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "ParentSectionId", "declared_type": "Guid?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-gLCode-section-list", "target_dapr_app_id": "accounting-service", "target_route": "gl-code-sections", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-gLCode-section-and-value-bpmn", "tags": [ "gl-code-sections" ], "summary": "aurax-bff-redirect-create-gLCode-section-and-value-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-gLCode-section-and-value-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "gl-code-sections", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "SectionType", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "SectionLength", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsMainParent", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsMandatory", "declared_type": null, "nullable": true, "collection": false }, { "name": "ParentSectionId", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/gl-code-sections/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-gLCode-section-bpmn", "tags": [ "gl-code-sections" ], "summary": "aurax-bff-redirect-delete-gLCode-section-bpmn", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-gLCode-section-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "gl-code-sections/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "get": { "operationId": "aurax-bff-redirect-get-gLCode-section-by-id", "tags": [ "gl-code-sections" ], "summary": "aurax-bff-redirect-get-gLCode-section-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-gLCode-section-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "gl-code-sections/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "GLCodeSectionDto", "payload": "GLCodeSectionDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "SectionType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SectionLength", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsMainParent", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "IsMandatory", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "ParentSectionId", "declared_type": "Guid?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-gLCode-section-by-id", "target_dapr_app_id": "accounting-service", "target_route": "gl-code-sections/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_43", "status": 400, "message": { "ar": "القسم {0} من رمز GL غير موجود.", "en": "Gl Code Section:{0} is not found.", "tr": "Gl Kodu Bölümü:{0} bulunamadı." }, "message_available": true, "constant_name": "SUITABLE_GL_CODE_SECTION_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-gLCode-section-and-value-bpmn", "tags": [ "gl-code-sections" ], "summary": "aurax-bff-redirect-update-gLCode-section-and-value-bpmn", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-gLCode-section-and-value-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "gl-code-sections/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "SectionType", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "SectionLength", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsMainParent", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsMandatory", "declared_type": null, "nullable": true, "collection": false }, { "name": "ParentSectionId", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/gl-code-sections/{id}/values": { "get": { "operationId": "aurax-bff-redirect-get-gLCode-section-value-list", "tags": [ "gl-code-sections" ], "summary": "aurax-bff-redirect-get-gLCode-section-value-list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-gLCode-section-value-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "gl-code-sections/{id}/values", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "GLCodeSectionValueDto", "collection": true, "members": [ { "name": "GLCodeSectionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "GLCodeSectionValueId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SectionValue", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ParentValueId", "declared_type": "Guid?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-gLCode-section-value-list", "target_dapr_app_id": "accounting-service", "target_route": "gl-code-sections/{id}/values", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_43", "status": 400, "message": { "ar": "القسم {0} من رمز GL غير موجود.", "en": "Gl Code Section:{0} is not found.", "tr": "Gl Kodu Bölümü:{0} bulunamadı." }, "message_available": true, "constant_name": "SUITABLE_GL_CODE_SECTION_NOT_FOUND" }, { "code": "ERR_ACCTNG_65", "status": 400, "message": { "ar": "يجب استخدام طرق دفتر الأستاذ للحصول على قيمة القسم الذي نوعه ليس هو دفتر الأستاذ.", "en": "Get Ledger methods should be used to get value of the section whose 'type' is not 'Ledger'.", "tr": "'Ledger' section type section value içermediği için sorgulanamaz." }, "message_available": true, "constant_name": "GET_LEDGER_METHODS_SHOULD_BE_USED_TO_GET_VALUE_OF_THE_SECTION_WHOSE_TYPE_IS_LEDGER" } ] } } }, "/gl-code-sections/{id}/values/{valueId}": { "delete": { "operationId": "aurax-bff-redirect-delete-gLCode-section-value", "tags": [ "gl-code-sections" ], "summary": "aurax-bff-redirect-delete-gLCode-section-value", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "valueId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-gLCode-section-value", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "gl-code-sections/{id}/values/{valueId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "ValueId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "forwarded": { "service_code": "delete-gLCode-section-value", "target_dapr_app_id": "accounting-service", "target_route": "gl-code-sections/{id}/values/{valueId}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_43", "status": 400, "message": { "ar": "القسم {0} من رمز GL غير موجود.", "en": "Gl Code Section:{0} is not found.", "tr": "Gl Kodu Bölümü:{0} bulunamadı." }, "message_available": true, "constant_name": "SUITABLE_GL_CODE_SECTION_NOT_FOUND" }, { "code": "ERR_ACCTNG_76", "status": 400, "message": { "ar": "لم يتم العثور على قيمة قسم رمز الحساب العام. معرف قيمة قسم رمز الحساب العام={0}.", "en": "GL Code Section Value not found. GL code section value id ={0}.", "tr": "GL Code Bölüm Değeri bulunamadı. GL kodu bölüm değeri id ={0}." }, "message_available": true, "constant_name": "SUITABLE_GL_CODE_SECTION_VALUE_NOT_FOUND" }, { "code": "ERR_ACCTNG_78", "status": 400, "message": { "ar": "الكودات العمومية باستخدام قيمة قسم الكود العمومي المحددة تُستخدم في قيد الحسابات. لا يمكن حذفها.", "en": "GL Codes with the given Gl Code Section Value is used for accounting entry. It cannot be deleted.", "tr": "Muhasebe girişi için Gl Kodu Bölüm Değeri verilen GL Kodları kullanılır. Silinemez." }, "message_available": true, "constant_name": "SECTION_VALUE_IS_USED_CANNOT_BE_DELETED" } ] } } }, "/ibans/virtual-ibans": { "post": { "operationId": "aurax-bff-redirect-create-virtual-iban", "tags": [ "ibans" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "Create Virtual Iban", "description": "Invokes the `aurax-bff-redirect-create-virtual-iban` service definition through `POST /ibans/virtual-ibans`.\n\nTurkish display name: Sanal Iban Oluştur\n\nRequest and response fields are declared on the routing target `create-virtual-iban`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "customerNumber": { "type": "string", "x-aura-field-code": "customerNumber" }, "fec": { "type": "integer", "format": "int32", "x-aura-field-code": "fec" } }, "required": [ "customerNumber", "fec" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 2, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-virtual-iban", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "ibans/virtual-ibans", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CustomerNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "Fec", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ExternalServiceLogDto", "envelopes": [ "ExternalServiceLogDto" ], "payload": "CreateVirtualIbanDto", "collection": false, "members": [ { "name": "VirtualIban", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/identities/custody-guardianship-control": { "get": { "operationId": "aurax-bff-redirect-custody-guardianship-control", "tags": [ "identities" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "Custody Guardianship Control", "description": "Invokes the `aurax-bff-redirect-custody-guardianship-control` service definition through `GET /identities/custody-guardianship-control`.\n\nRequest and response fields are declared on the routing target `custody-guardianship-control`; this entry declares none of its own.", "parameters": [ { "name": "citizenid", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true } }, { "name": "parentCitizenid", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "parentCitizenid" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 2 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-custody-guardianship-control", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "identities/custody-guardianship-control", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Citizenid", "declared_type": null, "nullable": false, "collection": false }, { "name": "ParentCitizenid", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ExternalServiceResultDto", "envelopes": [ "ExternalServiceResultDto" ], "payload": "CustodyGuardianshipControlDto", "collection": false, "members": [ { "name": "HasGuardian", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/identities/{parameter}": { "get": { "operationId": "aurax-bff-redirect-get-identity-parameter", "tags": [ "identities" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "get-identity-parameter", "description": "Invokes the `aurax-bff-redirect-get-identity-parameter` service definition through `GET /identities/{parameter}`.\n\nRequest and response fields are declared on the routing target `get-identity-parameter`; this entry declares none of its own.", "parameters": [ { "name": "parameter", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "identityParameter" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-identity-parameter", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "identities/{parameter}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Parameter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ExternalServiceResultDto", "envelopes": [ "ExternalServiceResultDto" ], "payload": "IdentityParameterDto", "collection": false, "members": [ { "name": "Parameters", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/identity-types": { "get": { "operationId": "aurax-bff-dynamic-get-identity-type-list", "tags": [ "identity-types" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-identity-type-list", "description": "Request and response fields are declared on the routing target `get-identity-type-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "identityTypeCode" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "identityTypeId" }, "identityTypeFields": { "type": "array", "items": { "type": "object", "properties": { "fieldKey": { "type": "string", "x-aura-field-code": "identityTypeFieldKey" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "identityTypeFieldId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "isMandatory": { "type": "boolean", "x-aura-field-code": "isMandatory" }, "sequenceNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "sequenceNumber" }, "translations": { "type": "array", "items": { "type": "object", "properties": { "languageCode": { "type": "string", "x-aura-field-code": "languageCode" }, "name": { "type": "string", "x-aura-field-code": "translations_name" } }, "x-aura-field-code": "translations" } }, "typeId": { "type": "string", "format": "uuid", "x-aura-field-code": "identityTypeId" } }, "x-aura-field-code": "identityTypeFields" } }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "name": { "type": "string", "x-aura-field-code": "identityTypeName" }, "translations": { "type": "array", "items": { "type": "object", "properties": { "languageCode": { "type": "string", "x-aura-field-code": "languageCode" }, "name": { "type": "string", "x-aura-field-code": "translations_name" } }, "x-aura-field-code": "translations" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-identity-type-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "identity-types", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-identity-type-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "post": { "operationId": "aurax-bff-dynamic-create-identity-template-bpm", "tags": [ "identity-types" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "create-identity-template-bpm", "description": "Invokes the `aurax-bff-dynamic-create-identity-template-bpm` service definition through `POST /identity-types`.\n\nRequest and response fields are declared on the routing target `create-identity-template-bpm`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "identityTypeCode" }, "identityTypeFields": { "type": "array", "items": { "type": "object", "properties": { "fieldContent": { "type": "string", "x-aura-field-code": "identityTypeFieldContent" }, "fieldKey": { "type": "string", "x-aura-field-code": "identityTypeFieldKey" }, "isMandatory": { "type": "boolean", "x-aura-field-code": "isMandatory" }, "sequenceNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "sequenceNumber" } }, "x-aura-field-code": "identityTypeFields" } }, "name": { "type": "string", "x-aura-field-code": "identityTypeName" } }, "required": [ "code", "name" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 3, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-create-identity-template-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "identity-types", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/identity-types/{id}": { "delete": { "operationId": "aurax-bff-dynamic-delete-identity-type-definition", "tags": [ "identity-types" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "delete-identity-type-definition", "description": "Invokes the `aurax-bff-dynamic-delete-identity-type-definition` service definition through `DELETE /identity-types/{id}`.\n\nRequest and response fields are declared on the routing target `delete-identity-type-definition`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "identityTypeId" } } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-delete-identity-type-definition", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "identity-types/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "get": { "operationId": "aurax-bff-dynamic-get-identity-type-by-id", "tags": [ "identity-types" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-identity-type-by-id", "description": "Request and response fields are declared on the routing target `get-identity-type-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "identityTypeId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "identityTypeCode" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "identityTypeId" }, "identityTypeFields": { "type": "array", "items": { "type": "object", "properties": { "fieldContent": { "type": "string", "x-aura-field-code": "identityTypeFieldContent" }, "fieldKey": { "type": "string", "x-aura-field-code": "identityTypeFieldKey" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "identityTypeFieldId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "isMandatory": { "type": "boolean", "x-aura-field-code": "isMandatory" }, "sequenceNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "sequenceNumber" }, "translations": { "type": "array", "items": { "type": "object", "properties": { "languageCode": { "type": "string", "x-aura-field-code": "languageCode" }, "name": { "type": "string", "x-aura-field-code": "translations_name" } }, "x-aura-field-code": "translations" } }, "typeId": { "type": "string", "format": "uuid", "x-aura-field-code": "identityTypeId" } }, "x-aura-field-code": "identityTypeFields" } }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "name": { "type": "string", "x-aura-field-code": "identityTypeName" }, "translations": { "type": "array", "items": { "type": "object", "properties": { "languageCode": { "type": "string", "x-aura-field-code": "languageCode" }, "name": { "type": "string", "x-aura-field-code": "translations_name" } }, "x-aura-field-code": "translations" } } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-identity-type-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "identity-types/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "put": { "operationId": "aurax-bff-dynamic-update-identity-template-bpm", "tags": [ "identity-types" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "update-identity-template-bpm", "description": "Invokes the `aurax-bff-dynamic-update-identity-template-bpm` service definition through `PUT /identity-types/{id}`.\n\nRequest and response fields are declared on the routing target `update-identity-template-bpm`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in this route template but not among the Route-bound fields of the routing target `update-identity-template-bpm`, whose own path is decoupled from this one.", "x-aura-source": "route-template-only-after-collapse" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "identityTypeCode" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "identityTypeId" }, "identityTypeFields": { "type": "array", "items": { "type": "object", "properties": { "fieldContent": { "type": "string", "x-aura-field-code": "identityTypeFieldContent" }, "fieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "identityTypeFieldId" }, "fieldKey": { "type": "string", "x-aura-field-code": "identityTypeFieldKey" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "isMandatory": { "type": "boolean", "x-aura-field-code": "isMandatory" }, "rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "sequenceNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "sequenceNumber" }, "typeId": { "type": "string", "format": "uuid", "x-aura-field-code": "identityTypeId" } }, "x-aura-field-code": "identityTypeFields" } }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "name": { "type": "string", "x-aura-field-code": "identityTypeName" } }, "required": [ "code", "id", "isActive", "name" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 5, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-update-identity-template-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "identity-types/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/import-lc-draft/{id}": { "get": { "operationId": "aurax-bff-get-by-id-import-letter-credit-draft", "tags": [ "import-lc-draft" ], "summary": "aurax-bff-get-by-id-import-letter-credit-draft", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": false, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "This usage type is outside the invocation layer's filtered set, so that layer applies no binding-source filter at all and every declared source is passed through.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-get-by-id-import-letter-credit-draft", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "import-lc-draft/{id}", "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/import-letter-credits": { "get": { "operationId": "aurax-bff-filter-import-letter-credits", "tags": [ "import-letter-credits" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-filter-import-letter-credits", "description": "Request and response fields are declared on the routing target `get-import-letter-credit-list`; this entry declares none of its own.", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a collection.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-filter-import-letter-credits", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "import-letter-credits", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-import-letter-credit-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Filter", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "ImportLetterCreditDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "BranchCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BranchName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Reference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DocumentType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CurrencyCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LCAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "RemainingAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "Status", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UpperTolerance", "declared_type": "int", "nullable": false, "collection": false }, { "name": "LowerTolerance", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Transferable", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "Confirmed", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "BeneficiaryAddress", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryCountyCode", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ReceiverBankBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReceiverBankBICCodeBankName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GoodsType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FormofDocumentaryCredit", "declared_type": "int", "nullable": false, "collection": false }, { "name": "FormofDocumentaryCreditName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ApplicableRule", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ApplicableRuleName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ApplicableRuleMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LCDueDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "DateOfExpiry", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "IssuingDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "PlaceOfExpiry", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AdditionalAmountCovered", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ApplicantBankBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AvailableWithBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AvailableWithBICCodeBankName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DraweeBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AvailableWith", "declared_type": "int", "nullable": false, "collection": false }, { "name": "AvailableWithName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DraftsAt", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MixedPaymentDetails", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PartialShipments", "declared_type": "int", "nullable": false, "collection": false }, { "name": "PartialShipmentsName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Transhipment", "declared_type": "int", "nullable": false, "collection": false }, { "name": "TranshipmentName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "NegotiationDetails", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LatestDateofShipment", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "ShipmentPeriod", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InvoiceNo", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InvoiceDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "GoodsName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Quantity", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Unit", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UnitPrice", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "GoodsCurrency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TotalGoodsAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "DeliveryVehicle", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DeliveryType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DeliveryPlace", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReceiptPlace", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DischargePort", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LoadingPort", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SpecialPaymentConditionsforBeneficiary", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SpecialPaymentConditionsforBankOnly", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ChargeDetail", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ChargeDetailName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ChargeDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PeriodforPresentationinDays", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "PeriodforPresentationinDaysDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ConfirmationInstructions", "declared_type": "int", "nullable": false, "collection": false }, { "name": "RequestConfirmationPartyBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RequestConfirmationPartyBICCodeBankName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReimbursementBankBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReimbursementBankBICCodeBankName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AdvisingBankBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AdvisingBankBICBankName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AdviseThroughBank", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SendertoReceiverInformation", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InstructionstothePaying", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AdditionalConditionsMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DocumentsRequiredsMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ShipmentInfoMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GroupGuid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InstructionstothePayingMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DraftsNarrative", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerNameandAddressMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AccountingBusinessKey", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RiskAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "MessagePurpose", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CancellationRequest", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AmendmentChargePayer", "declared_type": "int", "nullable": false, "collection": false }, { "name": "AmendmentChargePayerNarrative", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } }, "post": { "operationId": "aurax-bff-create-import-letter-credits", "tags": [ "import-letter-credits" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-create-import-letter-credits", "description": "Request and response fields are declared on the routing target `import-letter-credit-create-bpm`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "model": { "type": "object", "x-aura-field-code": "model" } }, "required": [ "model" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-create-import-letter-credits", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "import-letter-credits", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Model", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/import-letter-credits/preview-mt700": { "post": { "operationId": "aurax-bff-redirect-preview-mt-import-letter-credits", "tags": [ "import-letter-credits" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-preview-mt-import-letter-credits", "description": "Request and response fields are declared on the routing target `preview-mt-import-letter-credits`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "model": { "type": "object", "x-aura-field-code": "model" } }, "required": [ "model" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-preview-mt-import-letter-credits", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "import-letter-credits/preview-mt700", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Model", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "PreviewMT700Response", "payload": "PreviewMT700Response", "collection": false, "members": [ { "name": "MessageType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MessageText", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsValid", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "Errors", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Warnings", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." } } }, "/import-letter-credits/{id}": { "get": { "operationId": "aurax-bff-get-by-id-import-letter-credit", "tags": [ "import-letter-credits" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-get-by-id-import-letter-credit", "description": "Request and response fields are declared on the routing target `get-import-letter-credit-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "importLetterCreditId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-get-by-id-import-letter-credit", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "import-letter-credits/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ImportLetterCreditDto", "payload": "ImportLetterCreditDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "BranchCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BranchName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Reference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DocumentType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CurrencyCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LCAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "RemainingAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "Status", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UpperTolerance", "declared_type": "int", "nullable": false, "collection": false }, { "name": "LowerTolerance", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Transferable", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "Confirmed", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "BeneficiaryAddress", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryCountyCode", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ReceiverBankBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReceiverBankBICCodeBankName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GoodsType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FormofDocumentaryCredit", "declared_type": "int", "nullable": false, "collection": false }, { "name": "FormofDocumentaryCreditName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ApplicableRule", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ApplicableRuleName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ApplicableRuleMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LCDueDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "DateOfExpiry", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "IssuingDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "PlaceOfExpiry", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AdditionalAmountCovered", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ApplicantBankBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AvailableWithBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AvailableWithBICCodeBankName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DraweeBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AvailableWith", "declared_type": "int", "nullable": false, "collection": false }, { "name": "AvailableWithName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DraftsAt", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MixedPaymentDetails", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PartialShipments", "declared_type": "int", "nullable": false, "collection": false }, { "name": "PartialShipmentsName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Transhipment", "declared_type": "int", "nullable": false, "collection": false }, { "name": "TranshipmentName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "NegotiationDetails", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LatestDateofShipment", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "ShipmentPeriod", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InvoiceNo", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InvoiceDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "GoodsName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Quantity", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Unit", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UnitPrice", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "GoodsCurrency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TotalGoodsAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "DeliveryVehicle", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DeliveryType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DeliveryPlace", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReceiptPlace", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DischargePort", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LoadingPort", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SpecialPaymentConditionsforBeneficiary", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SpecialPaymentConditionsforBankOnly", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ChargeDetail", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ChargeDetailName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ChargeDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PeriodforPresentationinDays", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "PeriodforPresentationinDaysDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ConfirmationInstructions", "declared_type": "int", "nullable": false, "collection": false }, { "name": "RequestConfirmationPartyBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RequestConfirmationPartyBICCodeBankName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReimbursementBankBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReimbursementBankBICCodeBankName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AdvisingBankBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AdvisingBankBICBankName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AdviseThroughBank", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SendertoReceiverInformation", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InstructionstothePaying", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AdditionalConditionsMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DocumentsRequiredsMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ShipmentInfoMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GroupGuid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InstructionstothePayingMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DraftsNarrative", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerNameandAddressMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AccountingBusinessKey", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RiskAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "MessagePurpose", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CancellationRequest", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AmendmentChargePayer", "declared_type": "int", "nullable": false, "collection": false }, { "name": "AmendmentChargePayerNarrative", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_FRGN_TRD_57", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_LETTER_CREDIT_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-update-import-letter-credits", "tags": [ "import-letter-credits" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-update-import-letter-credits", "description": "Request and response fields are declared on the routing target `import-letter-credit-update-bpm`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in this route template but not among the Route-bound fields of the routing target `import-letter-credit-update-bpm`, whose own path is decoupled from this one.", "x-aura-source": "route-template-only-after-collapse" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-update-import-letter-credits", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "import-letter-credits/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "BranchCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BranchName", "declared_type": null, "nullable": false, "collection": false }, { "name": "Reference", "declared_type": null, "nullable": false, "collection": false }, { "name": "DocumentType", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "CurrencyCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "LCAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "RemainingAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "collection": false }, { "name": "UpperTolerance", "declared_type": null, "nullable": false, "collection": false }, { "name": "LowerTolerance", "declared_type": null, "nullable": false, "collection": false }, { "name": "Transferable", "declared_type": null, "nullable": true, "collection": false }, { "name": "Confirmed", "declared_type": null, "nullable": true, "collection": false }, { "name": "BeneficiaryAddress", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryCountyCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReceiverBankBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReceiverBankBICCodeBankName", "declared_type": null, "nullable": false, "collection": false }, { "name": "GoodsType", "declared_type": null, "nullable": false, "collection": false }, { "name": "FormofDocumentaryCredit", "declared_type": null, "nullable": false, "collection": false }, { "name": "FormofDocumentaryCreditName", "declared_type": null, "nullable": false, "collection": false }, { "name": "ApplicableRule", "declared_type": null, "nullable": false, "collection": false }, { "name": "ApplicableRuleName", "declared_type": null, "nullable": false, "collection": false }, { "name": "ApplicableRuleMessage", "declared_type": null, "nullable": false, "collection": false }, { "name": "LCDueDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "DateOfExpiry", "declared_type": null, "nullable": true, "collection": false }, { "name": "IssuingDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "PlaceOfExpiry", "declared_type": null, "nullable": false, "collection": false }, { "name": "AdditionalAmountCovered", "declared_type": null, "nullable": false, "collection": false }, { "name": "ApplicantBankBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "AvailableWithBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "AvailableWithBICCodeBankName", "declared_type": null, "nullable": false, "collection": false }, { "name": "DraweeBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "AvailableWith", "declared_type": null, "nullable": false, "collection": false }, { "name": "AvailableWithName", "declared_type": null, "nullable": false, "collection": false }, { "name": "DraftsAt", "declared_type": null, "nullable": false, "collection": false }, { "name": "MixedPaymentDetails", "declared_type": null, "nullable": false, "collection": false }, { "name": "PartialShipments", "declared_type": null, "nullable": false, "collection": false }, { "name": "PartialShipmentsName", "declared_type": null, "nullable": false, "collection": false }, { "name": "Transhipment", "declared_type": null, "nullable": false, "collection": false }, { "name": "TranshipmentName", "declared_type": null, "nullable": false, "collection": false }, { "name": "NegotiationDetails", "declared_type": null, "nullable": false, "collection": false }, { "name": "LatestDateofShipment", "declared_type": null, "nullable": true, "collection": false }, { "name": "ShipmentPeriod", "declared_type": null, "nullable": false, "collection": false }, { "name": "InvoiceNo", "declared_type": null, "nullable": false, "collection": false }, { "name": "InvoiceDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "GoodsName", "declared_type": null, "nullable": false, "collection": false }, { "name": "Quantity", "declared_type": null, "nullable": true, "collection": false }, { "name": "Unit", "declared_type": null, "nullable": false, "collection": false }, { "name": "UnitPrice", "declared_type": null, "nullable": true, "collection": false }, { "name": "GoodsCurrency", "declared_type": null, "nullable": false, "collection": false }, { "name": "TotalGoodsAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "DeliveryVehicle", "declared_type": null, "nullable": false, "collection": false }, { "name": "DeliveryType", "declared_type": null, "nullable": false, "collection": false }, { "name": "DeliveryPlace", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReceiptPlace", "declared_type": null, "nullable": false, "collection": false }, { "name": "DischargePort", "declared_type": null, "nullable": false, "collection": false }, { "name": "LoadingPort", "declared_type": null, "nullable": false, "collection": false }, { "name": "SpecialPaymentConditionsforBeneficiary", "declared_type": null, "nullable": false, "collection": false }, { "name": "SpecialPaymentConditionsforBankOnly", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChargeDetail", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChargeDetailName", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChargeDescription", "declared_type": null, "nullable": false, "collection": false }, { "name": "PeriodforPresentationinDays", "declared_type": null, "nullable": true, "collection": false }, { "name": "PeriodforPresentationinDaysDescription", "declared_type": null, "nullable": false, "collection": false }, { "name": "ConfirmationInstructions", "declared_type": null, "nullable": false, "collection": false }, { "name": "RequestConfirmationPartyBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "RequestConfirmationPartyBICCodeBankName", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReimbursementBankBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReimbursementBankBICCodeBankName", "declared_type": null, "nullable": false, "collection": false }, { "name": "AdvisingBankBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "AdvisingBankBICBankName", "declared_type": null, "nullable": false, "collection": false }, { "name": "AdviseThroughBank", "declared_type": null, "nullable": false, "collection": false }, { "name": "SendertoReceiverInformation", "declared_type": null, "nullable": false, "collection": false }, { "name": "InstructionstothePaying", "declared_type": null, "nullable": false, "collection": false }, { "name": "AdditionalConditionsMessage", "declared_type": null, "nullable": false, "collection": false }, { "name": "DocumentsRequiredsMessage", "declared_type": null, "nullable": false, "collection": false }, { "name": "ShipmentInfoMessage", "declared_type": null, "nullable": false, "collection": false }, { "name": "GroupGuid", "declared_type": null, "nullable": false, "collection": false }, { "name": "InstructionstothePayingMessage", "declared_type": null, "nullable": false, "collection": false }, { "name": "DraftsNarrative", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerNameandAddressMessage", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountingBusinessKey", "declared_type": null, "nullable": false, "collection": false }, { "name": "RiskAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "MessagePurpose", "declared_type": null, "nullable": false, "collection": false }, { "name": "CancellationRequest", "declared_type": null, "nullable": false, "collection": false }, { "name": "AmendmentChargePayer", "declared_type": null, "nullable": false, "collection": false }, { "name": "AmendmentChargePayerNarrative", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/import-letter-credits/{id}/set-cancelled": { "put": { "operationId": "aurax-bff-set-cancel-import-letter-credits", "tags": [ "import-letter-credits" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-set-cancel-import-letter-credits", "description": "Request and response fields are declared on the routing target `import-letter-credit-cancel-bpm`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in this route template but not among the Route-bound fields of the routing target `import-letter-credit-cancel-bpm`, whose own path is decoupled from this one.", "x-aura-source": "route-template-only-after-collapse" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-set-cancel-import-letter-credits", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "import-letter-credits/{id}/set-cancelled", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/import-letter-credits/{id}/set-returned": { "put": { "operationId": "aurax-bff-return-import-letter-credits", "tags": [ "import-letter-credits" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-return-import-letter-credits", "description": "Request and response fields are declared on the routing target `import-letter-credit-return-bpm`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in this route template but not among the Route-bound fields of the routing target `import-letter-credit-return-bpm`, whose own path is decoupled from this one.", "x-aura-source": "route-template-only-after-collapse" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-return-import-letter-credits", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "import-letter-credits/{id}/set-returned", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/incoming-distraint-files": { "get": { "operationId": "aurax-bff-dynamic-get-incoming-distraint-file-list", "tags": [ "incoming-distraint-files" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-incoming-distraint-file-list", "description": "Request and response fields are declared on the routing target `get-incoming-distraint-file-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a collection.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-incoming-distraint-file-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "incoming-distraint-files", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-incoming-distraint-file-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "IncomingDistraintFileDto", "collection": true, "members": [ { "name": "SourceOfficeType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "PackageCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ProcessType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "PackageItemCount", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PackageDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "PackageVersion", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "StatusSourceOffice", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ContentHash", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Details", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/incoming-distraint-files/{id}": { "get": { "operationId": "aurax-bff-dynamic-get-incoming-distraint-file-by-id", "tags": [ "incoming-distraint-files" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-incoming-distraint-file-by-id", "description": "Request and response fields are declared on the routing target `get-incoming-distraint-file-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-incoming-distraint-file-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "incoming-distraint-files/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IncomingDistraintFileDto", "payload": "IncomingDistraintFileDto", "collection": false, "members": [ { "name": "SourceOfficeType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "PackageCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ProcessType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "PackageItemCount", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PackageDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "PackageVersion", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "StatusSourceOffice", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ContentHash", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Details", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCNT_165", "status": 400, "message": null, "message_available": false, "constant_name": "INCOMING_DISTRAINT_FILE_NOT_FOUND" } ] } } }, "/incoming-distraint-files/{id}/details": { "get": { "operationId": "aurax-bff-dynamic-get-incoming-distraint-file-detail-list", "tags": [ "incoming-distraint-files" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-incoming-distraint-file-detail-list", "description": "Request and response fields are declared on the routing target `get-incoming-distraint-file-detail-list`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a collection.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-incoming-distraint-file-detail-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "incoming-distraint-files/{id}/details", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-incoming-distraint-file-detail-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "IncomingDistraintFileDetailDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "TaxOfficeCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DistraintNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TaxNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Surname", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FatherName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Amount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CurrencyId", "declared_type": "int?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/incoming-fasts/start": { "post": { "operationId": "aurax-bff-service-dynamic-start-incoming-fast", "tags": [ "incoming-fasts" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-start-incoming-fast", "description": "Request and response fields are declared on the routing target `start-incoming-fast`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "authorized": { "type": "object", "properties": { "accountId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountId" }, "address": { "type": "string", "x-aura-field-code": "address" }, "birthDate": { "type": "string", "format": "date", "x-aura-field-code": "birthDate" }, "birthPlace": { "type": "string", "x-aura-field-code": "birthPlace" }, "countryDistrict": { "type": "string", "x-aura-field-code": "countryDistrict" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "identityNumber": { "type": "string", "x-aura-field-code": "identityNumber" }, "owner": { "type": "string", "x-aura-field-code": "ownerName" } }, "x-aura-field-code": "authorized" }, "description": { "type": "string", "x-aura-field-code": "description" }, "externalSystemCode": { "type": "string", "x-aura-field-code": "externalSystemCode" }, "from": { "type": "object", "properties": { "accountId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountId" }, "address": { "type": "string", "x-aura-field-code": "address" }, "birthDate": { "type": "string", "format": "date", "x-aura-field-code": "birthDate" }, "birthPlace": { "type": "string", "x-aura-field-code": "birthPlace" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "iban": { "type": "string", "x-aura-field-code": "iban" }, "identityNumber": { "type": "string", "x-aura-field-code": "identityNumber" }, "owner": { "type": "string", "x-aura-field-code": "ownerName" }, "passportNumber": { "type": "string", "x-aura-field-code": "passportNumber" } }, "required": [ "address", "iban", "identityNumber", "owner" ], "x-aura-field-code": "fromAccount" }, "fromParticipantCode": { "type": "string", "x-aura-field-code": "fromParticipantCode" }, "layerService": { "type": "object", "properties": { "authorizedPaymentServiceProvider": { "type": "string", "x-aura-field-code": "authorizedPaymentServiceProvider" }, "barcodeProcessType": { "type": "string", "x-aura-field-code": "barcodeProcessType" }, "barcodeRef": { "type": "string", "x-aura-field-code": "barcodeRef" }, "easyAddressRef": { "type": "string", "x-aura-field-code": "easyAddressRef" }, "securityPaymentProcessType": { "type": "string", "x-aura-field-code": "securityPaymentProcessType" }, "securityPaymentRef": { "type": "string", "x-aura-field-code": "securityPaymentRef" } }, "x-aura-field-code": "layerService" }, "paymentPurpose": { "type": "integer", "format": "int32", "x-aura-field-code": "paymentPurpose", "x-aura-parameter-enumeration": { "state": "resolved", "parameter": "payment_purpose", "values": [ { "value": 1, "name": "Residential Rent Payment", "labels": { "en": "Residential Rent Payment", "tr": "Konut Kirası Ödemesi", "ar": "دفع إيجار السكن" } }, { "value": 2, "name": "Workplace Rent Payment", "labels": { "en": "Workplace Rent Payment", "tr": "İş Yeri Kirası Ödemesi", "ar": "دفع إيجار مكان العمل" } }, { "value": 3, "name": "Other Rent Payment", "labels": { "en": "Other Rent Payment", "tr": "Diğer Kira Ödemesi", "ar": "دفعة إيجار أخرى" } }, { "value": 4, "name": "E-Commerce Payment", "labels": { "en": "E-Commerce Payment", "tr": "E-Ticaret Ödemesi", "ar": "الدفع عبر التجارة الإلكترونية" } }, { "value": 5, "name": "Salary Payment", "labels": { "en": "Salary Payment", "tr": "Maaş Ödemesi", "ar": "دفع الراتب" } }, { "value": 6, "name": "Corporate Payment", "labels": { "en": "Individual Payment", "tr": "Bireysel Ödeme", "ar": "الدفع الفردي" } }, { "value": 7, "name": "Individual Payment", "labels": { "en": "Investment", "tr": "Yatırım", "ar": "استثمار" } }, { "value": 8, "name": "Investment", "labels": { "en": "Financial", "tr": "Finansal", "ar": "مالي" } }, { "value": 9, "name": "Financial", "labels": { "en": "Education Payment", "tr": "Eğitim Ödemesi", "ar": "دفع التعليم" } }, { "value": 10, "name": "Education Payment", "labels": { "en": "Membership Fee Payment", "tr": "Aidat Ödemesi", "ar": "دفع رسوم العضوية" } }, { "value": 11, "name": "Membership Fee Payment", "labels": { "en": "Other", "tr": "Diğer", "ar": "آخر" } }, { "value": 99, "name": "Others" } ] } }, "paymentSource": { "type": "string", "x-aura-field-code": "paymentSource" }, "queryNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "fastQueryNumber" }, "referenceInfo": { "type": "string", "x-aura-field-code": "referenceInfo" }, "to": { "type": "object", "properties": { "accountId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountId" }, "iban": { "type": "string", "x-aura-field-code": "iban" }, "identityNumber": { "type": "string", "x-aura-field-code": "identityNumber" }, "owner": { "type": "string", "x-aura-field-code": "ownerName" } }, "required": [ "iban", "identityNumber", "owner" ], "x-aura-field-code": "toAccount" }, "transactionDate": { "type": "string", "format": "date", "x-aura-field-code": "transactionDate" }, "transactionReference": { "type": "string", "x-aura-field-code": "transactionReference" } }, "required": [ "amount", "description", "externalSystemCode", "from", "fromParticipantCode", "paymentPurpose", "paymentSource", "queryNumber", "referenceInfo", "to", "transactionDate", "transactionReference" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 14, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-start-incoming-fast", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "incoming-fasts/start", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PaymentPurpose", "declared_type": null, "nullable": true, "collection": false }, { "name": "ExternalSystemCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "QueryNumber", "declared_type": null, "nullable": true, "collection": false }, { "name": "Amount", "declared_type": null, "nullable": true, "collection": false }, { "name": "Authorized", "declared_type": null, "nullable": false, "collection": false, "members": [ { "name": "CustomerId", "declared_type": null, "nullable": true, "collection": false }, { "name": "Owner", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountId", "declared_type": null, "nullable": true, "collection": false }, { "name": "IdentityNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "Address", "declared_type": null, "nullable": false, "collection": false }, { "name": "CountryDistrict", "declared_type": null, "nullable": false, "collection": false }, { "name": "BirthPlace", "declared_type": null, "nullable": false, "collection": false }, { "name": "BirthDate", "declared_type": null, "nullable": true, "collection": false } ] }, { "name": "PaymentSource", "declared_type": null, "nullable": false, "collection": false }, { "name": "FromParticipantCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "From", "declared_type": null, "nullable": false, "collection": false, "members": [ { "name": "CustomerId", "declared_type": null, "nullable": true, "collection": false }, { "name": "Owner", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountId", "declared_type": null, "nullable": true, "collection": false }, { "name": "Iban", "declared_type": null, "nullable": false, "collection": false }, { "name": "IdentityNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "Address", "declared_type": null, "nullable": false, "collection": false }, { "name": "PassportNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "BirthPlace", "declared_type": null, "nullable": false, "collection": false }, { "name": "BirthDate", "declared_type": null, "nullable": true, "collection": false } ] }, { "name": "To", "declared_type": null, "nullable": false, "collection": false, "members": [ { "name": "Owner", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountId", "declared_type": null, "nullable": true, "collection": false }, { "name": "Iban", "declared_type": null, "nullable": false, "collection": false }, { "name": "IdentityNumber", "declared_type": null, "nullable": false, "collection": false } ] }, { "name": "ReferenceInfo", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionReference", "declared_type": null, "nullable": false, "collection": false }, { "name": "LayerService", "declared_type": null, "nullable": false, "collection": false, "members": [ { "name": "EasyAddressRef", "declared_type": null, "nullable": false, "collection": false }, { "name": "BarcodeRef", "declared_type": null, "nullable": false, "collection": false }, { "name": "BarcodeProcessType", "declared_type": null, "nullable": false, "collection": false }, { "name": "AuthorizedPaymentServiceProvider", "declared_type": null, "nullable": false, "collection": false }, { "name": "SecurityPaymentRef", "declared_type": null, "nullable": false, "collection": false }, { "name": "SecurityPaymentProcessType", "declared_type": null, "nullable": false, "collection": false }, { "name": "PaymentRequestRef", "declared_type": null, "nullable": false, "collection": false }, { "name": "PaymentRequestProcessType", "declared_type": null, "nullable": false, "collection": false } ] }, { "name": "TransactionDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "ResponseCode", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "StartIncomingFastResponseDto", "payload": "StartIncomingFastResponseDto", "collection": false, "members": [ { "name": "ConfirmCode", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ConfirmCodeDetail", "declared_type": "int", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/incoming-letter-of-guarantees": { "get": { "operationId": "aurax-bff-redirect-get-incoming-letter-of-guarantees-list", "tags": [ "incoming-letter-of-guarantees" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-incoming-letter-of-guarantees-list", "description": "Request and response fields are declared on the routing target `get-incoming-letter-of-guarantees-list`; this entry declares none of its own.", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-incoming-letter-of-guarantees-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "incoming-letter-of-guarantees", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-incoming-letter-of-guarantees-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Filter", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "IncomingLetterOfGuaranteeDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "BranchCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Reference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GuaranteeReference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GuaranteeTypeCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "LetterTypeCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "GuaranteeCurrency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GuaranteeAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "GuaranteeExpiryTypeCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "GuaranteeExpiryDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "GuaranteeSubject", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RequestedBankBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ApplicantName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ApplicantAddress", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ApplicantCountry", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CounterGuarantor", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FirstCounterGuarantorBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SecondCounterGuarantorBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ThirdCounterGuarantorBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GuarantorBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FirstConfirmationBankBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SecondConfirmationBankBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FirstAdvisingBankBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SecondAdvisingBankBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CommissionRatio", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CommissionAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CommissionCurrency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CommissionTypeCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "NumberOfPeriods", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "PeriodicalAmountToBePaid", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "NonConvertibleCurrency", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "DirectGuaranteeTypeCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "StandByCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CounterGuarantyExpiryTypeCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CounterGuaranteeExpiryDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "PurposeOfMessageCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "DateOfIssue", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "FormOfUndertakingCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "UndertakingApplicableRuleTypeCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "UndertakingApplicableRuleNarrative", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExpiryConditionEventCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "AvailableWithBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AvailableWithBankNameAndAddress", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ConfirmationCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "RequestedConfirmationPartyBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GoverningLawJurisdictionCountryCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GoverningLawJurisdictionCountrySubDivision", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GoverningLawJurisdictionNarrative", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DocumentAndPresentationInstructions", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TermsAndConditions", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LocalRequestedDateOfIssue", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "LocalFormOfUndertaking", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LocalUndertakingApplicableRuleTypeCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "LocalUndertakingApplicableRuleNarrative", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LocalExpiryType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LocalDateOfExpiry", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "LocalExpiryConditionEvent", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LocalUndertakingAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "LocalUndertakingCurrency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IssuerBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IssuerBankNameAndAddress", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LocalUndertakingTermsAndConditions", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UnderlyingTransactionDetails", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BranchName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerNumber", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } }, "post": { "operationId": "aurax-bff-redirect-create-incoming-letter-of-guarantee", "tags": [ "incoming-letter-of-guarantees" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-create-incoming-letter-of-guarantee", "description": "Request and response fields are declared on the routing target `incoming-letter-of-guarantee-create-bpm`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "model": { "type": "object", "x-aura-field-code": "model" } }, "required": [ "model" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-incoming-letter-of-guarantee", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "incoming-letter-of-guarantees", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Model", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/incoming-letter-of-guarantees/preview-mt760": { "post": { "operationId": "aurax-bff-redirect-preview-mt-incoming-letter-of-guarantees", "tags": [ "incoming-letter-of-guarantees" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-preview-mt-incoming-letter-of-guarantees", "description": "Request and response fields are declared on the routing target `preview-mt-incoming-letter-of-guarantees`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "model": { "type": "object", "x-aura-field-code": "model" } }, "required": [ "model" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-preview-mt-incoming-letter-of-guarantees", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "incoming-letter-of-guarantees/preview-mt760", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Model", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "PreviewMT760Response", "payload": "PreviewMT760Response", "collection": false, "members": [ { "name": "MessageType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MessageText", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsValid", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "Errors", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Warnings", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." } } }, "/incoming-letter-of-guarantees/{id}": { "get": { "operationId": "aurax-bff-redirect-get-incoming-letter-of-guarantees-by-id", "tags": [ "incoming-letter-of-guarantees" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-incoming-letter-of-guarantees-by-id", "description": "Request and response fields are declared on the routing target `get-incoming-letter-of-guarantee-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "guidField" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-incoming-letter-of-guarantees-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "incoming-letter-of-guarantees/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IncomingLetterOfGuaranteeDto", "payload": "IncomingLetterOfGuaranteeDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "BranchCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Reference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GuaranteeReference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GuaranteeTypeCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "LetterTypeCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "GuaranteeCurrency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GuaranteeAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "GuaranteeExpiryTypeCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "GuaranteeExpiryDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "GuaranteeSubject", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RequestedBankBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ApplicantName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ApplicantAddress", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ApplicantCountry", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CounterGuarantor", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FirstCounterGuarantorBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SecondCounterGuarantorBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ThirdCounterGuarantorBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GuarantorBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FirstConfirmationBankBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SecondConfirmationBankBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FirstAdvisingBankBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SecondAdvisingBankBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CommissionRatio", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CommissionAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CommissionCurrency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CommissionTypeCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "NumberOfPeriods", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "PeriodicalAmountToBePaid", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "NonConvertibleCurrency", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "DirectGuaranteeTypeCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "StandByCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CounterGuarantyExpiryTypeCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CounterGuaranteeExpiryDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "PurposeOfMessageCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "DateOfIssue", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "FormOfUndertakingCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "UndertakingApplicableRuleTypeCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "UndertakingApplicableRuleNarrative", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExpiryConditionEventCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "AvailableWithBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AvailableWithBankNameAndAddress", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ConfirmationCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "RequestedConfirmationPartyBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GoverningLawJurisdictionCountryCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GoverningLawJurisdictionCountrySubDivision", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GoverningLawJurisdictionNarrative", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DocumentAndPresentationInstructions", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TermsAndConditions", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LocalRequestedDateOfIssue", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "LocalFormOfUndertaking", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LocalUndertakingApplicableRuleTypeCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "LocalUndertakingApplicableRuleNarrative", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LocalExpiryType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LocalDateOfExpiry", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "LocalExpiryConditionEvent", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LocalUndertakingAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "LocalUndertakingCurrency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IssuerBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IssuerBankNameAndAddress", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LocalUndertakingTermsAndConditions", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UnderlyingTransactionDetails", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BranchName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerNumber", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_FRGN_TRD_77", "status": 400, "message": null, "message_available": false, "constant_name": "INCOMING_LETTER_OF_GUARANTEE_NOT_FOUND" } ] } } }, "/installment-delay-penalties": { "get": { "operationId": "aurax-bff-redirect-installment-delay-penalties-ui-list", "tags": [ "installment-delay-penalties" ], "summary": "aurax-bff-redirect-installment-delay-penalties-ui-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-installment-delay-penalties-ui-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "installment-delay-penalties", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/installment-delay-penalties/{id}": { "get": { "operationId": "aurax-bff-redirect-installment-delay-penalty-detail", "tags": [ "installment-delay-penalties" ], "summary": "aurax-bff-redirect-installment-delay-penalty-detail", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-installment-delay-penalty-detail", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "installment-delay-penalties/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/integration-easy-addresses": { "get": { "operationId": "aurax-bff-service-dynamic-get-easy-address-definition", "tags": [ "integration-easy-addresses" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-get-easy-address-definition", "description": "Request and response fields are declared on the routing target `get-easy-address-definition`; this entry declares none of its own.", "parameters": [ { "name": "addressType", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "easyAddressType" } }, { "name": "addressValue", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "easyAddressValue" } }, { "name": "identityNumber", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "identityNumber" } }, { "name": "systemRef", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "systemRef" } }, { "name": "transactionid", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "transactionid" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-get-easy-address-definition", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "integration-easy-addresses", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "structure", "declared_type": "ExternalServiceResultDto", "envelopes": [ "ExternalServiceResultDto" ], "payload": "GetEasyAddressDto", "collection": false, "members": [ { "name": "ProxyAccount", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Errors", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names, except where a member states a wire name — there the wire name is the key to send." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_INTGRTN_84", "status": 400, "message": null, "message_available": false, "constant_name": "KOLAS_RECORD_NOT_FOUND" } ] } }, "post": { "operationId": "aurax-bff-service-dynamic-create-easy-address-definition", "tags": [ "integration-easy-addresses" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-create-easy-address-definition", "description": "Request and response fields are declared on the routing target `create-easy-address-definition`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "addressType": { "type": "string", "x-aura-field-code": "easyAddressType" }, "addressValue": { "type": "string", "x-aura-field-code": "easyAddressValue" }, "channelCode": { "type": "string", "x-aura-field-code": "channelCode" }, "customerTitle": { "type": "string", "x-aura-field-code": "customerTitle" }, "customerType": { "type": "string", "x-aura-field-code": "easyAddressCustomerType" }, "description": { "type": "string", "x-aura-field-code": "description" }, "iban": { "type": "string", "x-aura-field-code": "iban" }, "identityNumber": { "type": "string", "x-aura-field-code": "identityNumber" }, "owner": { "type": "string", "x-aura-field-code": "easyAddressOwner" }, "transactionid": { "type": "string", "x-aura-field-code": "transactionid" } }, "required": [ "addressType", "addressValue", "channelCode", "customerTitle", "customerType", "description", "iban", "identityNumber", "owner", "transactionid" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 10, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-create-easy-address-definition", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "integration-easy-addresses", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "structure", "declared_type": "ExternalServiceResultDto", "envelopes": [ "ExternalServiceResultDto" ], "payload": "EasyAddressDto", "collection": false, "members": [ { "name": "SystemRef", "declared_type": "long", "nullable": false, "collection": false }, { "name": "RecordStatus", "declared_type": "int", "nullable": false, "collection": false }, { "name": "CreatedDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "LastModifiedDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "Errors", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/interbank/{id}": { "post": { "operationId": "aurax-bff-service-dynamic-refund-interbank", "tags": [ "interbank" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-refund-interbank", "description": "Request and response fields are declared on the routing target `refund-interbank`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "x-aura-field-code": "description" }, "executionId": { "type": "string", "x-aura-field-code": "executionId" }, "priority": { "type": "integer", "format": "int32", "x-aura-field-code": "priority" }, "refundCode": { "type": "integer", "format": "int32", "x-aura-field-code": "refundCode", "x-aura-parameter-enumeration": { "state": "resolved", "parameter": "transfer_refund_code", "values": [ { "value": 1, "name": "Alıcı bilgileri eksik veya hatalı " }, { "value": 2, "name": "Hesap numarası ile alıcı ismi uyumsuz " }, { "value": 3, "name": "Hesap kapatılmış " }, { "value": 4, "name": "Hesap numarası yanlış (örneğin, IBAN hesap numarasında hata var" }, { "value": 5, "name": "Hesap EFT aktarımına uygun değil (örneğin, döviz hesabı)" }, { "value": 6, "name": "İade İsteği mesajına istinaden iade" }, { "value": 7, "name": "Mesajla gelen alıcı TCKN/VKN bilgisi katılımcıda ki kayıttan farklı" }, { "value": 8, "name": "Gönderici bilgileri eksik ya da hatalı" }, { "value": 9, "name": "IBAN’sız ödemelerde alıcı şube kodu hatalı" }, { "value": 10, "name": "Hesap yalnızca iade mesajıyla yapılan ödemelere açık" }, { "value": 11, "name": "Alıcı bilgileri ve hesap numarası bankamızda mevcut değil" }, { "value": 99, "name": "Diğer nedenler" } ] } }, "transferDate": { "type": "string", "format": "date-time", "x-aura-field-code": "transferDate" } }, "required": [ "description", "executionId", "priority", "refundCode", "transferDate" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 5, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-refund-interbank", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "interbank/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExecutionId", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "Priority", "declared_type": null, "nullable": true, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "RefundCode", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "command-id", "note": "The route returns `AuraCommandDto`, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, `Id`, of type `int`. A caller gets a JSON OBJECT with one field, not a bare value. The field is `id` on the wire.", "declared_type": "AuraCommandDto", "envelopes": [ "AuraCommandDto" ], "payload": "int", "collection": false, "members": [ { "name": "Id", "declared_type": "int", "nullable": false, "collection": false, "wire_name": "id", "wire_name_basis": "framework-naming-policy" } ], "naming": "Member names are the service's declaration names.", "synthesized": true } } }, "/interest-accruals": { "get": { "operationId": "aurax-bff-redirect-get-interest-accrual-list", "tags": [ "interest-accruals" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-interest-accrual-list", "description": "Request and response fields are declared on the routing target `get-interest-accrual-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a collection.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-interest-accrual-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "interest-accruals", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-interest-accrual-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Filter", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "InterestAccrualDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AccountId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "AccountProductId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "InterestRate", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "InterestAccrualDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "GrossAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "TaxAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "NetAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CurrencyId", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "AccrualAccountingEntryId", "declared_type": "Guid?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } }, "post": { "operationId": "aurax-bff-redirect-create-interest-accrual", "tags": [ "interest-accruals" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-create-interest-accrual", "description": "Request and response fields are declared on the routing target `create-interest-accrual`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "accountId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountId" }, "accountProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductId" }, "accrualAccountingEntryId": { "type": "string", "format": "uuid", "x-aura-field-code": "accrualAccountingEntryId" }, "currencyId": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyId" }, "grossAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "grossAmount" }, "interestAccrualDate": { "type": "string", "format": "date", "x-aura-field-code": "interestAccrualDate" }, "interestRate": { "type": "number", "format": "decimal", "x-aura-field-code": "interestRate" }, "netAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "netAmount" }, "taxAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "taxAmount" } }, "required": [ "accountId", "accountProductId", "currencyId" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 9, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-interest-accrual", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "interest-accruals", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "AccountId", "declared_type": null, "nullable": true, "collection": false }, { "name": "AccountProductId", "declared_type": null, "nullable": true, "collection": false }, { "name": "InterestRate", "declared_type": null, "nullable": true, "collection": false }, { "name": "InterestAccrualDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "GrossAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "TaxAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "NetAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "CurrencyId", "declared_type": null, "nullable": true, "collection": false }, { "name": "AccrualAccountingEntryId", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "command-id", "note": "The route returns `AuraCommandDto`, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, `Id`, of type `Guid`. A caller gets a JSON OBJECT with one field, not a bare value. The field is `id` on the wire.", "declared_type": "AuraCommandDto", "envelopes": [ "AuraCommandDto" ], "payload": "Guid", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false, "wire_name": "id", "wire_name_basis": "framework-naming-policy" } ], "naming": "Member names are the service's declaration names.", "synthesized": true }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/interest-accruals/{id}": { "get": { "operationId": "aurax-bff-redirect-get-interest-accrual-by-id", "tags": [ "interest-accruals" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-interest-accrual-by-id", "description": "Request and response fields are declared on the routing target `get-interest-accrual-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-interest-accrual-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "interest-accruals/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "InterestAccrualDto", "payload": "InterestAccrualDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AccountId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "AccountProductId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "InterestRate", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "InterestAccrualDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "GrossAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "TaxAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "NetAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CurrencyId", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "AccrualAccountingEntryId", "declared_type": "Guid?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/internal-vendors": { "get": { "operationId": "aurax-bff-redirect-get-vendor-internal-list", "tags": [ "internal-vendors" ], "summary": "aurax-bff-redirect-get-vendor-internal-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-vendor-internal-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "internal-vendors", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "VendorInternalDto", "collection": true, "members": [ { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "InternalVendorNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-vendor-internal-list", "target_dapr_app_id": "loan-service", "target_route": "internal-vendors", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-loan-internal-vendor-ui-bpmn", "tags": [ "internal-vendors" ], "summary": "aurax-bff-redirect-create-loan-internal-vendor-ui-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-loan-internal-vendor-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "internal-vendors", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/internal-vendors/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-internal-vendor", "tags": [ "internal-vendors" ], "summary": "aurax-bff-redirect-delete-internal-vendor", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-internal-vendor", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "internal-vendors/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "get": { "operationId": "aurax-bff-redirect-get-vendor-internal-details-by-id", "tags": [ "internal-vendors" ], "summary": "aurax-bff-redirect-get-vendor-internal-details-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-vendor-internal-details-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "internal-vendors/{id}", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "VendorInternalDetailsDto", "payload": "VendorInternalDetailsDto", "collection": false, "members": [ { "name": "Accounts", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-vendor-internal-details-by-id", "target_dapr_app_id": "loan-service", "target_route": "internal-vendors/{id}/details", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LOAN_2", "status": 400, "message": { "ar": "المورد الداخلي غير موجود. المعرف: {0}", "en": "Internal vendor cannot be found. :{0}", "tr": "Dahili satıcı bulunamadı. : {0}" }, "message_available": true, "constant_name": "VENDOR_INTERNAL_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-loan-internal-vendor-ui-bpmn", "tags": [ "internal-vendors" ], "summary": "aurax-bff-redirect-update-loan-internal-vendor-ui-bpmn", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-loan-internal-vendor-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "internal-vendors/{id}", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/internal-vendors/{id}/accounts": { "get": { "operationId": "aurax-bff-redirect-get-vendor-internal-account-list", "tags": [ "internal-vendors" ], "summary": "aurax-bff-redirect-get-vendor-internal-account-list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-vendor-internal-account-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "internal-vendors/{id}/accounts", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "VendorInternalAccountDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Iban", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerAccountId", "declared_type": "Guid?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-vendor-internal-account-list", "target_dapr_app_id": "loan-service", "target_route": "internal-vendors/{id}/accounts", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LOAN_2", "status": 400, "message": { "ar": "المورد الداخلي غير موجود. المعرف: {0}", "en": "Internal vendor cannot be found. :{0}", "tr": "Dahili satıcı bulunamadı. : {0}" }, "message_available": true, "constant_name": "VENDOR_INTERNAL_NOT_FOUND" } ] } }, "post": { "operationId": "aurax-bff-redirect-create-vendor-internal-account", "tags": [ "internal-vendors" ], "summary": "aurax-bff-redirect-create-vendor-internal-account", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-vendor-internal-account", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "internal-vendors/{id}/accounts", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "forwarded": { "service_code": "create-vendor-internal-account", "target_dapr_app_id": "loan-service", "target_route": "internal-vendors/{id}/accounts", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LOAN_2", "status": 400, "message": { "ar": "المورد الداخلي غير موجود. المعرف: {0}", "en": "Internal vendor cannot be found. :{0}", "tr": "Dahili satıcı bulunamadı. : {0}" }, "message_available": true, "constant_name": "VENDOR_INTERNAL_NOT_FOUND" } ] } } }, "/internal-vendors/{id}/accounts/{vendorAccountId}": { "delete": { "operationId": "aurax-bff-redirect-delete-vendor-internal-account", "tags": [ "internal-vendors" ], "summary": "aurax-bff-redirect-delete-vendor-internal-account", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "vendorAccountId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-vendor-internal-account", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "internal-vendors/{id}/accounts/{vendorAccountId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "VendorAccountId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "forwarded": { "service_code": "delete-vendor-internal-account", "target_dapr_app_id": "loan-service", "target_route": "internal-vendors/{id}/accounts/{vendorAccountId}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LOAN_2", "status": 400, "message": { "ar": "المورد الداخلي غير موجود. المعرف: {0}", "en": "Internal vendor cannot be found. :{0}", "tr": "Dahili satıcı bulunamadı. : {0}" }, "message_available": true, "constant_name": "VENDOR_INTERNAL_NOT_FOUND" }, { "code": "ERR_LOAN_4", "status": 400, "message": { "ar": "لا يوجد سجل حساب. المعرف:{0}", "en": "Account record cannot be found. :{0}", "tr": "Hesap kaydı bulunamadı. : {0}" }, "message_available": true, "constant_name": "VENDOR_INTERNAL_ACCOUNT_NOT_FOUND" } ] } } }, "/key-formats/by-code/{code}/generate": { "post": { "operationId": "aurax-bff-redirect-customer-generate-key", "tags": [ "key-formats" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-customer-generate-key", "description": "Request and response fields are declared on the routing target `customer-generate-key`; this entry declares none of its own.", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "code" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemValues": { "type": "object", "x-aura-field-code": "itemValues" } } } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-customer-generate-key", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "key-formats/by-code/{code}/generate", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "route-claimed-by-two-repositories", "note": "Two services register this method and path, so this portal cannot say which one's request fields these would be. The fields a caller sends are exactly what would differ between them, so nothing is published rather than one of the two." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/keycloak-logout": { "post": { "operationId": "aurax-bff-redirect-keycloak-logout", "tags": [ "keycloak-logout" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-keycloak-logout", "description": "Invokes the `aurax-bff-redirect-keycloak-logout` service definition through `POST /keycloak-logout`.\n\nRequest and response fields are declared on the routing target `keycloak-logout`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "refreshToken": { "type": "string", "x-aura-field-code": "refreshToken" } }, "required": [ "refreshToken" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-keycloak-logout", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "keycloak-logout", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/kyc-references/by-citizenid/{citizenId}": { "get": { "operationId": "aurax-bff-redirect-get-kyc-reference-by-citizen-id", "tags": [ "kyc-references" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-kyc-reference-by-citizen-id", "description": "Request and response fields are declared on the routing target `get-kyc-reference-by-citizen-id`; this entry declares none of its own.", "parameters": [ { "name": "citizenId", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "citizenId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "citizenId": { "type": "string", "x-aura-field-code": "citizenId" }, "createdDate": { "type": "string", "format": "date-time", "x-aura-field-code": "createdDate" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "description": { "type": "string", "x-aura-field-code": "description" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "kycReferenceId", "x-aura-encrypted": true }, "isSuccess": { "type": "boolean", "x-aura-field-code": "isSuccess" }, "modifiedDate": { "type": "string", "format": "date-time", "x-aura-field-code": "modifiedDate" }, "referenceId": { "type": "string", "x-aura-field-code": "referenceId" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-kyc-reference-by-citizen-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "kyc-references/by-citizenid/{citizenId}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CitizenId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "KycReferenceDto", "payload": "KycReferenceDto", "collection": false, "members": [ { "name": "CitizenId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsSuccess", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CreatedDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "ModifiedDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "CustomerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ReferenceId", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_INTGRTN_53", "status": 400, "message": { "ar": "لا يمكن العثور على مرجع التحقق من الهوية (KYC).", "en": "KYC reference cannot be found.", "tr": "KYC referansı bulunamadı." }, "message_available": true, "constant_name": "KYC_REFERENCE_NOT_FOUND" } ] } } }, "/languages": { "get": { "operationId": "aurax-bff-redirect-get-language-list", "tags": [ "languages" ], "summary": "aurax-bff-redirect-get-language-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-language-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "languages", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "LanguageDto", "collection": true, "members": [ { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Alpha2", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Alpha3", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsRtl", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "Translations", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-language-list", "target_dapr_app_id": "core-service", "target_route": "languages", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/ledger-balances/details": { "get": { "operationId": "aurax-bff-redirect-get-ledger-balance-detail", "tags": [ "ledger-balances" ], "summary": "aurax-bff-redirect-get-ledger-balance-detail", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-ledger-balance-detail", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "ledger-balances/details", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "LedgerBalanceDetailDto", "collection": true, "members": [ { "name": "TransactionDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "LedgerCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LedgerName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CurrencyCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OrganizationCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BalanceType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "DebitAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "CreditAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "DebitBalance", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "CreditBalance", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "AccountingEntryId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ReversalAccountingEntryId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "FinancialTransactionCode", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-ledger-balance-detail", "target_dapr_app_id": "accounting-service", "target_route": "ledger-balances/details", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_175", "status": 400, "message": { "ar": "يجب أن يكون تاريخ الانتهاء أكبر من تاريخ البداية.", "en": "'endDate' must be bigger than 'beginDate'.", "tr": "'endDate' 'beginDate' den büyük olmalı." }, "message_available": true, "constant_name": "END_DATE_MUST_BE_BIGGER_BEGIN_DATE" }, { "code": "ERR_ACCTNG_190", "status": 400, "message": { "ar": "غير مسموح بالاستعلام عن رصيد مؤجل لمزيد من التاريخ.", "en": "It is not allowed to query a future dated balance.", "tr": "İleri tarihli bakiye sorgulamaya izin verilmez." }, "message_available": true, "constant_name": "DATE_CANNOT_BE_GREATER_THAN_TODAY" } ] } } }, "/ledger-code-matrix": { "get": { "operationId": "aurax-bff-redirect-get-ledger-matrix-list", "tags": [ "ledger-code-matrix" ], "summary": "aurax-bff-redirect-get-ledger-matrix-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-ledger-matrix-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "ledger-code-matrix", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Filter", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "LedgerMatrixDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LedgerMatrixFields", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-ledger-matrix-list", "target_dapr_app_id": "accounting-service", "target_route": "ledger-code-matrix", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-ledger-matrix", "tags": [ "ledger-code-matrix" ], "summary": "aurax-bff-redirect-create-ledger-matrix", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-ledger-matrix", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "ledger-code-matrix", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/ledger-code-matrix-fields/{id}/fields/{fieldId}": { "get": { "operationId": "aurax-bff-redirect-get-ledger-matrix-field-by-id", "tags": [ "ledger-code-matrix-fields" ], "summary": "aurax-bff-redirect-get-ledger-matrix-field-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "fieldId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-ledger-matrix-field-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "ledger-code-matrix-fields/{id}/fields/{fieldId}", "x-aura-code-response": { "state": "structure", "declared_type": "LedgerMatrixFieldByIdDto", "payload": "LedgerMatrixFieldByIdDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "LedgerMatrixId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LedgerMatrixValues", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-ledger-matrix-field-by-id", "target_dapr_app_id": "accounting-service", "target_route": "ledger-code-matrix/{id}/by-field-id/{fieldId}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_108", "status": 400, "message": { "ar": "لم يتم العثور على حقل مصفوفة دفتر الأستاذ بالمعرف المحدد '{0}'.", "en": "Ledger Matrix Field is not found with given id '{0}'.", "tr": "Verilen '{0}' kimliğiyle Genel Muhasebe Matrisi Alanı bulunamadı." }, "message_available": true, "constant_name": "LEDGER_MATRIX_TABLE_COLUMN_IS_NOT_FOUND" }, { "code": "ERR_ACCTNG_96", "status": 400, "message": { "ar": "لم يتم العثور على مصفوفة السجل بالمعرف المقدم '{0}'.", "en": "Ledger matrix is not found with given id '{0}'.", "tr": "Verilen '{0}' kimliğiyle genel muhasebe matrisi bulunamadı." }, "message_available": true, "constant_name": "LEDGER_MATRIX_TABLE_NOT_FOUND" } ] } } }, "/ledger-code-matrix-values/{id}/fields/{fieldId}": { "get": { "operationId": "aurax-bff-redirect-get-ledger-matrix-value-list", "tags": [ "ledger-code-matrix-values" ], "summary": "aurax-bff-redirect-get-ledger-matrix-value-list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "fieldId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-ledger-matrix-value-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "ledger-code-matrix-values/{id}/fields/{fieldId}", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "LedgerMatrixValueDto", "collection": true, "members": [ { "name": "ValueId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "MainLedgerCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LedgerCode", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-ledger-matrix-value-list", "target_dapr_app_id": "accounting-service", "target_route": "ledger-code-matrix/{id}/fields/{fieldId}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_108", "status": 400, "message": { "ar": "لم يتم العثور على حقل مصفوفة دفتر الأستاذ بالمعرف المحدد '{0}'.", "en": "Ledger Matrix Field is not found with given id '{0}'.", "tr": "Verilen '{0}' kimliğiyle Genel Muhasebe Matrisi Alanı bulunamadı." }, "message_available": true, "constant_name": "LEDGER_MATRIX_TABLE_COLUMN_IS_NOT_FOUND" }, { "code": "ERR_ACCTNG_96", "status": 400, "message": { "ar": "لم يتم العثور على مصفوفة السجل بالمعرف المقدم '{0}'.", "en": "Ledger matrix is not found with given id '{0}'.", "tr": "Verilen '{0}' kimliğiyle genel muhasebe matrisi bulunamadı." }, "message_available": true, "constant_name": "LEDGER_MATRIX_TABLE_NOT_FOUND" } ] } } }, "/ledger-code-matrix/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-ledger-matrix-and-fields-and-value-bpmn", "tags": [ "ledger-code-matrix" ], "summary": "aurax-bff-redirect-delete-ledger-matrix-and-fields-and-value-bpmn", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-ledger-matrix-and-fields-and-value-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "ledger-code-matrix/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "get": { "operationId": "aurax-bff-redirect-get-ledger-matrix-by-id", "tags": [ "ledger-code-matrix" ], "summary": "aurax-bff-redirect-get-ledger-matrix-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-ledger-matrix-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "ledger-code-matrix/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "LedgerMatrixDto", "payload": "LedgerMatrixDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LedgerMatrixFields", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-ledger-matrix-by-id", "target_dapr_app_id": "accounting-service", "target_route": "ledger-code-matrix/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_96", "status": 400, "message": { "ar": "لم يتم العثور على مصفوفة السجل بالمعرف المقدم '{0}'.", "en": "Ledger matrix is not found with given id '{0}'.", "tr": "Verilen '{0}' kimliğiyle genel muhasebe matrisi bulunamadı." }, "message_available": true, "constant_name": "LEDGER_MATRIX_TABLE_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-ledger-matrix", "tags": [ "ledger-code-matrix" ], "summary": "aurax-bff-redirect-update-ledger-matrix", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-ledger-matrix", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "ledger-code-matrix/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/ledger-code-matrix/{id}/fields": { "get": { "operationId": "aurax-bff-redirect-get-ledger-matrix-field-by-ledger-matrix-id", "tags": [ "ledger-code-matrix" ], "summary": "aurax-bff-redirect-get-ledger-matrix-field-by-ledger-matrix-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-ledger-matrix-field-by-ledger-matrix-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "ledger-code-matrix/{id}/fields", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "LedgerMatrixFieldDto", "collection": true, "members": [ { "name": "LedgerMatrixId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "FieldId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-ledger-matrix-field-by-ledger-matrix-id", "target_dapr_app_id": "accounting-service", "target_route": "ledger-code-matrix/{id}/fields", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/ledger-code-matrix/{id}/fields/{fieldId}": { "delete": { "operationId": "aurax-bff-redirect-delete-ledger-matrix-fields-and-value-bpmn", "tags": [ "ledger-code-matrix" ], "summary": "aurax-bff-redirect-delete-ledger-matrix-fields-and-value-bpmn", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "fieldId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-ledger-matrix-fields-and-value-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "ledger-code-matrix/{id}/fields/{fieldId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "FieldId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/ledger-level-format": { "get": { "operationId": "aurax-bff-redirect-get-ledger-level-format-list", "tags": [ "ledger-level-format" ], "summary": "aurax-bff-redirect-get-ledger-level-format-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-ledger-level-format-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "ledger-level-format", "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "LedgerLevelFormatDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "LedgerLevel", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "LevelLength", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "LevelSeparator", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CumulativeLength", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsFreeLength", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-ledger-level-format-list", "target_dapr_app_id": "accounting-service", "target_route": "ledger-level-formats", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-update-ledger-level-format-bpmn", "tags": [ "ledger-level-format" ], "summary": "aurax-bff-redirect-create-update-ledger-level-format-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-update-ledger-level-format-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "ledger-level-format", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/ledger-level-formats": { "delete": { "operationId": "aurax-bff-redirect-delete-ledger-level-format-bpmn", "tags": [ "ledger-level-formats" ], "summary": "aurax-bff-redirect-delete-ledger-level-format-bpmn", "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-ledger-level-format-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "ledger-level-formats", "x-aura-request-contract": { "state": "no-members" }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/ledger-matrix/field-values": { "post": { "operationId": "aurax-bff-redirect-create-ledger-matrix-field-and-value-bpmn", "tags": [ "ledger-matrix" ], "summary": "aurax-bff-redirect-create-ledger-matrix-field-and-value-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-ledger-matrix-field-and-value-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "ledger-matrix/field-values", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "put": { "operationId": "aurax-bff-redirect-update-ledger-matrix-field-and-value-bpmn", "tags": [ "ledger-matrix" ], "summary": "aurax-bff-redirect-update-ledger-matrix-field-and-value-bpmn", "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-ledger-matrix-field-and-value-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "ledger-matrix/field-values", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/ledgers": { "get": { "operationId": "aurax-bff-redirect-get-ledger-list", "tags": [ "ledgers" ], "summary": "aurax-bff-redirect-get-ledger-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-ledger-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "ledgers", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "LedgerCodeBegin", "declared_type": null, "nullable": false, "collection": false }, { "name": "LedgerCodeEnd", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeginLedgerCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "LedgerDto", "collection": true, "members": [ { "name": "LedgerCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Type", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "LedgerLevel", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "PassiveDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "MainCategory", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Category", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Character", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsManualEntry", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "CustomerOption", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CurrencyType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CurrencyGroup", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "HasNegativeBalance", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "ParentLedgerCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PaddedLedgerCode", "declared_type": "long", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-ledger-list", "target_dapr_app_id": "accounting-service", "target_route": "ledgers", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_22", "status": 400, "message": { "ar": "يجب أن يكون 'ledgerCodeEnd' أكبر من 'ledgerCodeBegin'.", "en": "'ledgerCodeEnd' must be bigger than 'ledgerCodeBegin'.", "tr": "'ledgerCodeEnd', 'ledgerCodeBegin'den büyük olmalıdır." }, "message_available": true, "constant_name": "END_LERGER_MUST_BE_BIGGER_BEGIN_LEDGER" } ] } }, "post": { "operationId": "aurax-bff-redirect-create-ledger-bpmn", "tags": [ "ledgers" ], "summary": "aurax-bff-redirect-create-ledger-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-ledger-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "ledgers", "x-aura-request-contract": { "state": "no-members" }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/ledgers/by-ledger-code/{ledgerCode}": { "get": { "operationId": "aurax-bff-redirect-get-ledger-by-ledger-code", "tags": [ "ledgers" ], "summary": "aurax-bff-redirect-get-ledger-by-ledger-code", "parameters": [ { "name": "ledgerCode", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-ledger-by-ledger-code", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "ledgers/by-ledger-code/{ledgerCode}", "x-aura-request-contract": { "state": "route-claimed-by-two-repositories", "note": "Two services register this method and path, so this portal cannot say which one's request fields these would be. The fields a caller sends are exactly what would differ between them, so nothing is published rather than one of the two." }, "x-aura-code-response": { "state": "structure", "declared_type": "LedgerDto", "payload": "LedgerDto", "collection": false, "members": [ { "name": "LedgerCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Type", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "LedgerLevel", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "PassiveDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "MainCategory", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Category", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Character", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsManualEntry", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "CustomerOption", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CurrencyType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CurrencyGroup", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "HasNegativeBalance", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "ParentLedgerCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PaddedLedgerCode", "declared_type": "long", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-ledger-by-ledger-code", "target_dapr_app_id": "accounting-service", "target_route": "ledgers/by-ledger-code/{ledgerCode}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_21", "status": 400, "message": { "ar": "السجل '{0}' غير موجود", "en": "Ledger '{0}' is not found", "tr": "'{0}' defteri bulunamadı" }, "message_available": true, "constant_name": "LEDGER_MUST_BE_NOT_NULL" } ] } } }, "/ledgers/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-ledger-bpmn", "tags": [ "ledgers" ], "summary": "aurax-bff-redirect-delete-ledger-bpmn", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-ledger-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "ledgers/{id}", "x-aura-request-contract": { "state": "no-members" }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "get": { "operationId": "aurax-bff-redirect-get-ledger-by-id", "tags": [ "ledgers" ], "summary": "aurax-bff-redirect-get-ledger-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-ledger-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "ledgers/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "LedgerDto", "payload": "LedgerDto", "collection": false, "members": [ { "name": "LedgerCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Type", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "LedgerLevel", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "PassiveDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "MainCategory", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Category", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Character", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsManualEntry", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "CustomerOption", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CurrencyType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CurrencyGroup", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "HasNegativeBalance", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "ParentLedgerCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PaddedLedgerCode", "declared_type": "long", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-ledger-by-id", "target_dapr_app_id": "accounting-service", "target_route": "ledgers/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_26", "status": 400, "message": { "ar": "لم يتم العثور على سجل بالدليل المعطى: '{0}'.", "en": "Ledger is not found with the given id : '{0}'.", "tr": "Belirtilen kimliğe sahip defter bulunamadı: '{0}'." }, "message_available": true, "constant_name": "LEDGER_NOT_FOUND_BY_ID" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-ledger-bpmn", "tags": [ "ledgers" ], "summary": "aurax-bff-redirect-update-ledger-bpmn", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-ledger-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "ledgers/{id}", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/legal-follows": { "get": { "operationId": "aurax-bff-redirect-get-customer-follow-ui-list", "tags": [ "legal-follows" ], "summary": "aurax-bff-redirect-get-customer-follow-ui-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-customer-follow-ui-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "legal-follows", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/legal-follows/{loanId}": { "get": { "operationId": "aurax-bff-redirect-get-customer-follow-detail-ui-list", "tags": [ "legal-follows" ], "summary": "aurax-bff-redirect-get-customer-follow-detail-ui-list", "parameters": [ { "name": "loanId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-customer-follow-detail-ui-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "legal-follows/{loanId}", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/limit-items": { "get": { "operationId": "aurax-bff-redirect-get-limit-item-list", "tags": [ "limit-items" ], "summary": "aurax-bff-redirect-get-limit-item-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. It returns a page of records under `data`, with `total` carrying the unpaged count — but the record's fields are not declared.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-limit-item-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "limit-items", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "LimitItemDto", "collection": true, "members": [ { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LevelNumber", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-limit-item-list", "target_dapr_app_id": "transaction-limit-service", "target_route": "limit-items", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-limit-item-bpm", "tags": [ "limit-items" ], "summary": "aurax-bff-redirect-limit-item-bpm", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-limit-item-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "limit-items", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Code", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "LevelNumber", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/limit-items/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-limit-item", "tags": [ "limit-items" ], "summary": "aurax-bff-redirect-delete-limit-item", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-limit-item", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "limit-items/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "forwarded": { "service_code": "delete-limit-item", "target_dapr_app_id": "transaction-limit-service", "target_route": "limit-items/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_TRLMT_2", "status": 400, "message": { "ar": "يجب ألا يكون الحد الأدنى للعناصر فارغًا.", "en": "Limit item must not be null.", "tr": "Limit öğesi boş olmamalıdır." }, "message_available": true, "constant_name": "LIMIT_ITEM_MUST_NOT_BE_NULL" } ] } }, "get": { "operationId": "aurax-bff-redirect-get-limit-item-by-id", "tags": [ "limit-items" ], "summary": "aurax-bff-redirect-get-limit-item-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-limit-item-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "limit-items/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "LimitItemDto", "payload": "LimitItemDto", "collection": false, "members": [ { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LevelNumber", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-limit-item-by-id", "target_dapr_app_id": "transaction-limit-service", "target_route": "limit-items/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "put": { "operationId": "aurax-bff-redirect-update-limit-item-bpm", "tags": [ "limit-items" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-update-limit-item-bpm", "x-aura-incomplete-contract": { "note": "Presence of this extension means the request and response schemas on this operation are known to be incomplete. Absence means no declared field was dropped for this reason — it is not a claim that the catalog is otherwise complete." }, "description": "Invokes the `aurax-bff-redirect-update-limit-item-bpm` service definition through `PUT /limit-items/{id}`.\n\nRequest and response fields are declared on the routing target `update-limit-item-bpm`; this entry declares none of its own.\n\nINCOMPLETE CONTRACT. The catalog declares 19 request field(s), 10 of them Mandatory (_rowStatus, _rowStatus, currencyNumber, isDefault, limitAmount, limitCount, limitMaxAmount, limitMinAmount, period, serviceDefinitionId) that this document could NOT place and does not show: the catalog parents this field to a row belonging to a DIFFERENT service, so it is a child of a node that is not part of this contract. So the properties and any `required` array below are a SUBSET of what the catalog declares, not the whole of it. They are dropped rather than re-attached because placing them would mean guessing which node they belong under, and this document does not guess. See `x-aura-incomplete-contract` for the field names.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in this route template but not among the Route-bound fields of the routing target `update-limit-item-bpm`, whose own path is decoupled from this one.", "x-aura-source": "route-template-only-after-collapse" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "code" }, "description": { "type": "string", "x-aura-field-code": "description" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "limitItemId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "levelNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "levelNumber" }, "limitDimensionList": { "type": "array", "items": { "type": "object", "x-aura-field-code": "limitDimensionList" } }, "limitItemServiceMapList": { "type": "array", "items": { "type": "object", "x-aura-field-code": "limitItemServiceMapList" } }, "name": { "type": "string", "x-aura-field-code": "name", "x-aura-maskable": true } }, "required": [ "code", "description", "levelNumber", "name" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 8, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-limit-item-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "limit-items/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "LevelNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/limit-items/{id}/dimensions": { "get": { "operationId": "aurax-bff-redirec-get-limit-item-dimension-list-by-id", "tags": [ "limit-items" ], "summary": "aurax-bff-redirec-get-limit-item-dimension-list-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. It returns a collection of records — but the record's fields are not declared.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirec-get-limit-item-dimension-list-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "limit-items/{id}/dimensions", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "LimitItemDimensionDto", "collection": true, "members": [ { "name": "LimitItemId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Period", "declared_type": "int", "nullable": false, "collection": false }, { "name": "CustomerType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LimitAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "LimitCount", "declared_type": "int", "nullable": false, "collection": false }, { "name": "LimitMaxAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "LimitMinAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "IsDefault", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "StartDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "EndDate", "declared_type": "DateOnly?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-limit-item-dimension-list-by-id", "target_dapr_app_id": "transaction-limit-service", "target_route": "limit-items/{id}/dimensions", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_TRLMT_2", "status": 400, "message": { "ar": "يجب ألا يكون الحد الأدنى للعناصر فارغًا.", "en": "Limit item must not be null.", "tr": "Limit öğesi boş olmamalıdır." }, "message_available": true, "constant_name": "LIMIT_ITEM_MUST_NOT_BE_NULL" } ] } } }, "/limit-items/{id}/service-maps": { "get": { "operationId": "aurax-bff-redirect-get-limit-item-service-map-list", "tags": [ "limit-items" ], "summary": "aurax-bff-redirect-get-limit-item-service-map-list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. It returns a page of records under `data`, with `total` carrying the unpaged count — but the record's fields are not declared.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-limit-item-service-map-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "limit-items/{id}/service-maps", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "LimitItemServiceMapDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "LimitItemId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ServiceDefinitionId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-limit-item-service-map-list", "target_dapr_app_id": "transaction-limit-service", "target_route": "limit-items/{id}/service-maps", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/loan-campaigns": { "get": { "operationId": "aurax-bff-redirect-get-loan-campaign-list", "tags": [ "loan-campaigns" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-loan-campaign-list", "description": "Request and response fields are declared on the routing target `get-loan-campaign-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "beginDate": { "type": "string", "format": "date-time", "x-aura-field-code": "beginDate" }, "delayMonth": { "type": "integer", "format": "int32", "x-aura-field-code": "delayMonth" }, "description": { "type": "string", "x-aura-field-code": "authorityDescription" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "loanCampaignId" }, "loanProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanProductId" }, "name": { "type": "string", "x-aura-field-code": "loanCampaignName" }, "partnerId": { "type": "string", "format": "uuid", "x-aura-field-code": "partnerId" }, "priority": { "type": "integer", "format": "int32", "x-aura-field-code": "priority" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-loan-campaign-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loan-campaigns", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-loan-campaign-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "LoanCampaignDto", "collection": true, "members": [ { "name": "PartnerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "LoanProductId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "BeginDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "EndDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "Amount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "Priority", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DelayMonth", "declared_type": "int?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." } }, "post": { "operationId": "aurax-bff-redirect-create-loan-campaign-bpm", "tags": [ "loan-campaigns" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "create-loan-campaign-bpm", "description": "Invokes the `aurax-bff-redirect-create-loan-campaign-bpm` service definition through `POST /loan-campaigns`.\n\nRequest and response fields are declared on the routing target `create-loan-campaign-bpm`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "beginDate": { "type": "string", "format": "date-time", "x-aura-field-code": "beginDate" }, "delayMonth": { "type": "integer", "format": "int32", "x-aura-field-code": "delayMonth" }, "description": { "type": "string", "x-aura-field-code": "description" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "loanProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanProductId" }, "name": { "type": "string", "x-aura-field-code": "loanCampaignName" }, "partnerId": { "type": "string", "format": "uuid", "x-aura-field-code": "partnerId" }, "priority": { "type": "integer", "format": "int32", "x-aura-field-code": "priority" } }, "required": [ "amount", "beginDate", "delayMonth", "description", "endDate", "loanProductId", "name", "partnerId", "priority" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 9, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "loanCampaignId" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "loanCampaignId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "loanCampaignId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-loan-campaign-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loan-campaigns", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PartnerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "LoanProductId", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeginDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "EndDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "Amount", "declared_type": null, "nullable": false, "collection": false }, { "name": "Priority", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "DelayMonth", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/loan-campaigns/{id}": { "get": { "operationId": "aurax-bff-redirect-get-loan-campaign-by-id", "tags": [ "loan-campaigns" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-loan-campaign-by-id", "description": "Request and response fields are declared on the routing target `get-loan-campaign-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "loanCampaignId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-loan-campaign-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loan-campaigns/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "LoanCampaignDto", "payload": "LoanCampaignDto", "collection": false, "members": [ { "name": "PartnerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "LoanProductId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "BeginDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "EndDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "Amount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "Priority", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DelayMonth", "declared_type": "int?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_CAMPAIGN_1", "status": 400, "message": null, "message_available": false, "constant_name": "LOAN_CAMPAIGN_MUST_BE_NOT_NULL" } ] } }, "put": { "operationId": "aurax-bff-redirect-edit-loan-campaign-bpm", "tags": [ "loan-campaigns" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "edit-loan-campaign-bpm", "description": "Invokes the `aurax-bff-redirect-edit-loan-campaign-bpm` service definition through `PUT /loan-campaigns/{id}`.\n\nRequest and response fields are declared on the routing target `edit-loan-campaign-bpm`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "loanCampaignId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" } }, "required": [ "endDate" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-edit-loan-campaign-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loan-campaigns/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "EndDate", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/loan-collections": { "get": { "operationId": "aurax-bff-redirect-get-loan-collection-list", "tags": [ "loan-collections" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-loan-collection-list", "description": "Request and response fields are declared on the routing target `get-loan-collection-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "collectionType": { "type": "integer", "format": "int32", "x-aura-field-code": "collectionType" }, "description": { "type": "string", "x-aura-field-code": "description" }, "followTypeId": { "type": "string", "format": "uuid", "x-aura-field-code": "followTypeId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "loanCollectionId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "loanProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanProductId" }, "name": { "type": "string", "x-aura-field-code": "name", "x-aura-maskable": true } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-loan-collection-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loan-collections", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-loan-collection-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "LoanCollectionDto", "collection": true, "members": [ { "name": "LoanProductId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "CollectionType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "FollowTypeId", "declared_type": "Guid?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-loan-collection-list", "target_dapr_app_id": "loan-collection-service", "target_route": "loan-collections", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-loan-collection-ui-bpm", "tags": [ "loan-collections" ], "summary": "aurax-bff-redirect-create-loan-collection-ui-bpm", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-loan-collection-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loan-collections", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "LoanProductId", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "CollectionType", "declared_type": null, "nullable": false, "collection": false }, { "name": "FollowTypeId", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/loan-collections/{id}": { "get": { "operationId": "aurax-bff-redirect-get-loan-collection-details-by-id", "tags": [ "loan-collections" ], "summary": "aurax-bff-redirect-get-loan-collection-details-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-loan-collection-details-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loan-collections/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "LoanCollectionDetailsDto", "payload": "LoanCollectionDetailsDto", "collection": false, "members": [ { "name": "ItemSequences", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Taxes", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-loan-collection-details-by-id", "target_dapr_app_id": "loan-collection-service", "target_route": "loan-collections/{id}/details", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_COLLECTION_2", "status": 400, "message": { "ar": "لا يمكن العثور على تحصيل القرض: {0}", "en": "Loan collection cannot be found. : {0}", "tr": "Kredi tahsilatı bulunamadı. : {0}" }, "message_available": true, "constant_name": "LOAN_COLLECTION_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-loan-collection-ui-bpm", "tags": [ "loan-collections" ], "summary": "aurax-bff-redirect-update-loan-collection-ui-bpm", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-loan-collection-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loan-collections/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "LoanProductId", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "CollectionType", "declared_type": null, "nullable": false, "collection": false }, { "name": "FollowTypeId", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/loan-collections/{id}/sequences": { "get": { "operationId": "aurax-bff-redirect-get-loan-collection-sequences-by-id", "tags": [ "loan-collections" ], "summary": "aurax-bff-redirect-get-loan-collection-sequences-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-loan-collection-sequences-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loan-collections/{id}/sequences", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "LoanCollectionSequenceDto", "collection": true, "members": [ { "name": "SequenceNo", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CollectionItem", "declared_type": "int", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-loan-collection-sequences-by-id", "target_dapr_app_id": "loan-collection-service", "target_route": "loan-collections/{id}/sequences", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_COLLECTION_2", "status": 400, "message": { "ar": "لا يمكن العثور على تحصيل القرض: {0}", "en": "Loan collection cannot be found. : {0}", "tr": "Kredi tahsilatı bulunamadı. : {0}" }, "message_available": true, "constant_name": "LOAN_COLLECTION_NOT_FOUND" } ] } } }, "/loan-payout-reservations": { "post": { "operationId": "aurax-bff-service-dynamic-create-loan-payout-reservation", "tags": [ "loan-payout-reservations" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-create-loan-payout-reservation", "description": "Request and response fields are declared on the routing target `create-loan-payout-reservation`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "loanProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanProductId" }, "reservationStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "reservationStatus", "x-aura-parameter-enumeration": { "state": "resolved", "parameter": "loan_status", "values": [ { "value": 1, "name": "INAPPROVAL", "labels": { "en": "INAPPROVAL", "tr": "Onayda", "ar": "غير موافق" } }, { "value": 2, "name": "APPROVED", "labels": { "en": "APPROVED", "tr": "Onaylandı", "ar": "موافق" } }, { "value": 3, "name": "REJECTED", "labels": { "en": "REJECTED", "tr": "Reddedildi", "ar": "مرفوض" } }, { "value": 4, "name": "PAYMENT", "labels": { "en": "PAYMENT", "tr": "Ödeme", "ar": "الدفع" } }, { "value": 5, "name": "FINALIZED", "labels": { "en": "Finalized", "tr": "Kesinleştirildi", "ar": "تم الانتهاء منه" } }, { "value": 6, "name": "CLOSED", "labels": { "en": "CLOSED", "tr": "Kapandı", "ar": "مُغلق" } }, { "value": 7, "name": "FINALIZATION CANCELLATION", "labels": { "en": "Finalization Cancellation", "tr": "Kesinleştirme İptali", "ar": "إلغاء الإنهاء" } }, { "value": 8, "name": "PAYMENT CANCELLATION", "labels": { "en": "Payment Cancellation", "tr": "Ödeme İptali", "ar": "إلغاء الدفع" } }, { "value": 9, "name": "CANCELLED", "labels": { "en": "CANCELED", "tr": "İptal Edildi", "ar": "ملغاة" } }, { "value": 10, "name": "SAVED", "labels": { "en": "Saved", "tr": "Kaydedildi", "ar": "تم الحفظ" } }, { "value": 11, "name": "WAITING FOR FINALIZATION", "labels": { "en": "Waiting For Finalization", "tr": "Kesinleştirme Bekliyor", "ar": "انتظار الانتهاء" } }, { "value": 12, "name": "WAITING FOR CANCELLIZATION", "labels": { "en": "Waiting For Cancellization", "tr": "İptal Bekliyor", "ar": "انتظار إلغاء الحجز" } }, { "value": 13, "name": "LATE CANCELLED", "labels": { "en": "LATE CANCELLED", "tr": "Geç İptal Edildi", "ar": "تم الإلغاء متأخرًا" } } ] } } }, "required": [ "amount", "customerId", "loanProductId", "reservationStatus" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 4, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-create-loan-payout-reservation", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loan-payout-reservations", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "ReservationStatus", "declared_type": null, "nullable": false, "collection": false }, { "name": "Amount", "declared_type": null, "nullable": true, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "LoanProductId", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "command-id", "note": "The route returns `AuraCommandDto`, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, `Id`, of type `Guid`. A caller gets a JSON OBJECT with one field, not a bare value. The field is `id` on the wire.", "declared_type": "AuraCommandDto", "envelopes": [ "AuraCommandDto" ], "payload": "Guid", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false, "wire_name": "id", "wire_name_basis": "framework-naming-policy" } ], "naming": "Member names are the service's declaration names.", "synthesized": true }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/loan-payout-reservations/{id}": { "put": { "operationId": "aurax-bff-service-dynamic-update-loan-payout-reservation", "tags": [ "loan-payout-reservations" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-update-loan-payout-reservation", "description": "Request and response fields are declared on the routing target `update-loan-payout-reservation`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "loanPayoutReservationId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "loanProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanProductId" }, "reservationStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "reservationStatus", "x-aura-parameter-enumeration": { "state": "resolved", "parameter": "loan_status", "values": [ { "value": 1, "name": "INAPPROVAL", "labels": { "en": "INAPPROVAL", "tr": "Onayda", "ar": "غير موافق" } }, { "value": 2, "name": "APPROVED", "labels": { "en": "APPROVED", "tr": "Onaylandı", "ar": "موافق" } }, { "value": 3, "name": "REJECTED", "labels": { "en": "REJECTED", "tr": "Reddedildi", "ar": "مرفوض" } }, { "value": 4, "name": "PAYMENT", "labels": { "en": "PAYMENT", "tr": "Ödeme", "ar": "الدفع" } }, { "value": 5, "name": "FINALIZED", "labels": { "en": "Finalized", "tr": "Kesinleştirildi", "ar": "تم الانتهاء منه" } }, { "value": 6, "name": "CLOSED", "labels": { "en": "CLOSED", "tr": "Kapandı", "ar": "مُغلق" } }, { "value": 7, "name": "FINALIZATION CANCELLATION", "labels": { "en": "Finalization Cancellation", "tr": "Kesinleştirme İptali", "ar": "إلغاء الإنهاء" } }, { "value": 8, "name": "PAYMENT CANCELLATION", "labels": { "en": "Payment Cancellation", "tr": "Ödeme İptali", "ar": "إلغاء الدفع" } }, { "value": 9, "name": "CANCELLED", "labels": { "en": "CANCELED", "tr": "İptal Edildi", "ar": "ملغاة" } }, { "value": 10, "name": "SAVED", "labels": { "en": "Saved", "tr": "Kaydedildi", "ar": "تم الحفظ" } }, { "value": 11, "name": "WAITING FOR FINALIZATION", "labels": { "en": "Waiting For Finalization", "tr": "Kesinleştirme Bekliyor", "ar": "انتظار الانتهاء" } }, { "value": 12, "name": "WAITING FOR CANCELLIZATION", "labels": { "en": "Waiting For Cancellization", "tr": "İptal Bekliyor", "ar": "انتظار إلغاء الحجز" } }, { "value": 13, "name": "LATE CANCELLED", "labels": { "en": "LATE CANCELLED", "tr": "Geç İptal Edildi", "ar": "تم الإلغاء متأخرًا" } } ] } } }, "required": [ "amount", "customerId", "loanProductId", "reservationStatus" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 4, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-update-loan-payout-reservation", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loan-payout-reservations/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReservationStatus", "declared_type": null, "nullable": false, "collection": false }, { "name": "Amount", "declared_type": null, "nullable": true, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "LoanProductId", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LOAN_109", "status": 400, "message": null, "message_available": false, "constant_name": "LOAN_PAYOUT_RESERVATION_NOT_FOUND" } ] } } }, "/loan-reconciliations": { "get": { "operationId": "aurax-bff-redirect-loan-reconciliation-ui-list", "tags": [ "loan-reconciliations" ], "summary": "aurax-bff-redirect-loan-reconciliation-ui-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-loan-reconciliation-ui-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loan-reconciliations", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/loan/accrulstatu-check": { "post": { "operationId": "aurax-bff-redirect-loan-accrulstatu-check-scheduler-bpmn", "tags": [ "loan" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-loan-accrulstatu-check-scheduler-bpmn", "description": "Request and response fields are declared on the routing target `loan-accrulstatu-check-scheduler-bpmn`; this entry declares none of its own.", "parameters": [ { "name": "loanAccrualDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time", "x-aura-field-code": "loanAccrualDate" } } ], "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 1 }, "dropped_binding_sources": [ "query" ], "dropped_field_names": { "query": [ "loanAccrualDate" ] }, "dropped_mandatory_field_names": [], "verdict": "declared-fields-not-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-loan-accrulstatu-check-scheduler-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loan/accrulstatu-check", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/loan/update-accrual-status": { "put": { "operationId": "aurax-bff-redirect-update-loan-accrual-status", "tags": [ "loan" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-update-loan-accrual-status", "description": "Request and response fields are declared on the routing target `update-loan-accrual-status`; this entry declares none of its own.\n\nDeclared as Route-bound but absent from the route template, so not sendable: id.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "accrualStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "accrualStatus", "x-aura-parameter-enumeration": { "state": "resolved", "parameter": "accrual_status", "values": [ { "value": 1, "name": "Not Accrued" }, { "value": 2, "name": "Accrual Completed" }, { "value": 3, "name": "Error at Accrual" }, { "value": 4, "name": "Accrul Canceled" }, { "value": 5, "name": "Collection Exist - Accrual Not Canceled" } ] } } }, "required": [ "accrualStatus" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-loan-accrual-status", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loan/update-accrual-status", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LOAN_17", "status": 400, "message": null, "message_available": false, "constant_name": "LOAN_MUST_NOT_BE_NULL" } ] } } }, "/loans": { "get": { "operationId": "aurax-bff-redirect-get-loan-list", "tags": [ "loans" ], "summary": "aurax-bff-redirect-get-loan-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-loan-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loans", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "LoanDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CustomerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ProposalId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CustomerApplicationId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CustomerAccountId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "LoanProductId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "LoanNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FundingSource", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "OrganizationId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Amount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "LoanDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "Status", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ExchangeRate", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "AccountingEntryId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "LoanCloseDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "LoanCloseType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CustomerRiskId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "AllotmentQueryId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ParentLoanId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CancelDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "CancelReason", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CancelDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LatePenaltyRate", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "EarlyPaymentDiscountRate", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "AccrualStatus", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ExternalReference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExternalTransactionid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "VendorExternalId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "StatusContext", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PartnerId", "declared_type": "Guid?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-loan-list", "target_dapr_app_id": "loan-service", "target_route": "loans", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-loan-without-account-ui", "tags": [ "loans" ], "summary": "aurax-bff-redirect-create-loan-without-account-ui", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-loan-without-account-ui", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loans", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "ProposalId", "declared_type": null, "nullable": false, "collection": false }, { "name": "ProposalPaybackPlanId", "declared_type": null, "nullable": true, "collection": false }, { "name": "LoanProductId", "declared_type": null, "nullable": false, "collection": false }, { "name": "MonthlyRepaymentRate", "declared_type": null, "nullable": true, "collection": false }, { "name": "FundingSource", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrganizationId", "declared_type": null, "nullable": true, "collection": false }, { "name": "CustomerApplicationId", "declared_type": null, "nullable": true, "collection": false }, { "name": "ExchangeRate", "declared_type": null, "nullable": true, "collection": false }, { "name": "LatePenaltyRate", "declared_type": null, "nullable": true, "collection": false }, { "name": "EarlyPaymentDiscountRate", "declared_type": null, "nullable": true, "collection": false }, { "name": "ExternalReference", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExternalTransactionid", "declared_type": null, "nullable": false, "collection": false }, { "name": "CurrencyNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "VendorExternalId", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/loans/by-customer-id": { "get": { "operationId": "aurax-bff-redirect-get-loan-list-by-customer-id", "tags": [ "loans" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-loan-list-by-customer-id", "description": "Read from the caller's token, not from the request: customerId.", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 1, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-loan-list-by-customer-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loans/by-customer-id", "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/loans/by-customer-id/{customerId}/vendor-details": { "get": { "operationId": "aurax-bff-redirect-get-loan-vendor-detail-list-by-customer-id", "tags": [ "loans" ], "summary": "aurax-bff-redirect-get-loan-vendor-detail-list-by-customer-id", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-loan-vendor-detail-list-by-customer-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loans/by-customer-id/{customerId}/vendor-details", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/loans/by-installment-id/{installmentId}/installment": { "get": { "operationId": "aurax-bff-redirect-get-loan-installment-details-by-installment-id", "tags": [ "loans" ], "summary": "aurax-bff-redirect-get-loan-installment-details-by-installment-id", "parameters": [ { "name": "installmentId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-loan-installment-details-by-installment-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loans/by-installment-id/{installmentId}/installment", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "InstallmentId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "InstallmentDto", "payload": "InstallmentDto", "collection": false, "members": [ { "name": "InstallmentNo", "declared_type": "int", "nullable": false, "collection": false }, { "name": "InstallmentDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "InstallmentTotalAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "CollectionStatus", "declared_type": "int", "nullable": false, "collection": false }, { "name": "IsAccrual", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "PrincipalAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "RemainingPrincipalAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "ProfitAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "BalloonPaymentAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "CalculateInstallmentDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "IsManual", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "LoanId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "LoanPaybackPlanId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Taxes", "declared_type": "List", "nullable": false, "collection": true }, { "name": "CollectionDetails", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-loan-installment-details-by-installment-id", "target_dapr_app_id": "loan-service", "target_route": "loans/by-installment-id/{installmentId}/installment", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LOAN_30", "status": 400, "message": { "ar": "لم يتم العثور على القسط. المعرف: {0}", "en": "Installment cannot be found. :{0}", "tr": "Taksit bulunamadı. : {0}" }, "message_available": true, "constant_name": "LOAN_INSTALLMENT_MUST_NOT_BE_NULL" } ] } } }, "/loans/calculate-installment-delay-penalty": { "post": { "operationId": "aurax-bff-redirect-calculate-installment-delay-penalty-bpmn", "tags": [ "loans" ], "summary": "aurax-bff-redirect-calculate-installment-delay-penalty-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-calculate-installment-delay-penalty-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loans/calculate-installment-delay-penalty", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/loans/calculate-partial-payment": { "post": { "operationId": "aurax-bff-redirect-calculate-partial-payment-bpmn", "tags": [ "loans" ], "summary": "aurax-bff-redirect-calculate-partial-payment-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-calculate-partial-payment-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loans/calculate-partial-payment", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/loans/calculate-payment": { "post": { "operationId": "aurax-bff-redirect-calculate-payment-bpmn", "tags": [ "loans" ], "summary": "aurax-bff-redirect-calculate-payment-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-calculate-payment-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loans/calculate-payment", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/loans/cancel": { "post": { "operationId": "aurax-bff-redirect-cancel-loan-bpmn", "tags": [ "loans" ], "summary": "aurax-bff-redirect-cancel-loan-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-cancel-loan-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loans/cancel", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/loans/confirm-loan-application": { "post": { "operationId": "aurax-bff-redirect-confirm-loan-ui-bpmn", "tags": [ "loans" ], "summary": "aurax-bff-redirect-confirm-loan-ui-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-confirm-loan-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loans/confirm-loan-application", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/loans/corporate": { "post": { "operationId": "aurax-bff-redirect-create-loan-for-corporate-ui-bpmn", "tags": [ "loans" ], "summary": "aurax-bff-redirect-create-loan-for-corporate-ui-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-loan-for-corporate-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loans/corporate", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/loans/customer-total-debt-bpmn": { "post": { "operationId": "aurax-bff-redirect-calculate-customer-current-total-loan-debt-bpmn", "tags": [ "loans" ], "summary": "aurax-bff-redirect-calculate-customer-current-total-loan-debt-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-calculate-customer-current-total-loan-debt-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loans/customer-total-debt-bpmn", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/loans/delegations": { "get": { "operationId": "aurax-bff-redirect-get-delegation-list", "tags": [ "loans" ], "summary": "aurax-bff-redirect-get-delegation-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-delegation-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loans/delegations", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "LoanDelegationDto", "collection": true, "members": [ { "name": "LoanId", "declared_type": "Guid", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-delegation-list", "target_dapr_app_id": "loan-service", "target_route": "loans/delegations", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-loan-delegation-ui-bpm", "tags": [ "loans" ], "summary": "aurax-bff-redirect-create-loan-delegation-ui-bpm", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-loan-delegation-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loans/delegations", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/loans/details": { "get": { "operationId": "aurax-bff-redirect-get-loan-details-ui-list", "tags": [ "loans" ], "summary": "aurax-bff-redirect-get-loan-details-ui-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-loan-details-ui-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loans/details", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/loans/insurances": { "get": { "operationId": "aurax-bff-redirect-get-insurance-list", "tags": [ "loans" ], "summary": "aurax-bff-redirect-get-insurance-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-insurance-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loans/insurances", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "InsuranceDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Type", "declared_type": "int", "nullable": false, "collection": false }, { "name": "PolicyNumber", "declared_type": "int", "nullable": false, "collection": false }, { "name": "LoanId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ProductName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Company", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PolicyHolderNumber", "declared_type": "int", "nullable": false, "collection": false }, { "name": "CoverageCurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PolicyHolderFullname", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LossPayee", "declared_type": "string", "nullable": false, "collection": false }, { "name": "VehicleBrand", "declared_type": "string", "nullable": false, "collection": false }, { "name": "VehicleModel", "declared_type": "string", "nullable": false, "collection": false }, { "name": "VehicleType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "EngineNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ChassisNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Plate", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PremiumAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "PremiumCurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CoverageAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "StartDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "EndDate", "declared_type": "DateTime?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-insurance-list", "target_dapr_app_id": "loan-service", "target_route": "loans/insurances", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-insurance-bpmn", "tags": [ "loans" ], "summary": "aurax-bff-redirect-create-insurance-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-insurance-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loans/insurances", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/loans/internal-external-disbursements": { "get": { "operationId": "aurax-bff-redirect-get-vendor-disbursement-list-query", "tags": [ "loans" ], "summary": "aurax-bff-redirect-get-vendor-disbursement-list-query", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-vendor-disbursement-list-query", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loans/internal-external-disbursements", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/loans/loan-finalization": { "post": { "operationId": "aurax-bff-redirect-loan-finalization-ui-bpmn", "tags": [ "loans" ], "summary": "aurax-bff-redirect-loan-finalization-ui-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-loan-finalization-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loans/loan-finalization", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/loans/loan-for-externalfirm": { "post": { "operationId": "aurax-bff-redirect-create-loan-for-external-firm-bpmn", "tags": [ "loans" ], "summary": "aurax-bff-redirect-create-loan-for-external-firm-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-loan-for-external-firm-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loans/loan-for-externalfirm", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/loans/metal-purchases": { "get": { "operationId": "aurax-bff-redirect-get-metal-purchase-list", "tags": [ "loans" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-metal-purchase-list", "description": "Request and response fields are declared on the routing target `get-metal-purchase-list`; this entry declares none of its own.", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a collection.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-metal-purchase-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loans/metal-purchases", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "LoanMetalPurchaseDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "LoanId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CurrencyId", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UnitPrice", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "Weight", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "GlBalanceId", "declared_type": "Guid?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/loans/payback-plans/document-context": { "post": { "operationId": "aurax-bff-redirect-loan-paybackPlan-document-context-bpmn", "tags": [ "loans" ], "summary": "aurax-bff-redirect-loan-paybackPlan-document-context-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-loan-paybackPlan-document-context-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loans/payback-plans/document-context", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/loans/return-payment-for-externalfirm": { "post": { "operationId": "aurax-bff-redirect-create-loan-return-payment-bpmn", "tags": [ "loans" ], "summary": "aurax-bff-redirect-create-loan-return-payment-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-loan-return-payment-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loans/return-payment-for-externalfirm", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/loans/return-payments": { "get": { "operationId": "aurax-bff-redirect-get-loan-return-payment-list", "tags": [ "loans" ], "summary": "aurax-bff-redirect-get-loan-return-payment-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-loan-return-payment-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loans/return-payments", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "LoanReturnPaymentBaseDto", "collection": true, "members": [ { "name": "Amount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "LoanId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ReturnProcessingDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "ReturnDate", "declared_type": "DateTime", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-loan-return-payment-list", "target_dapr_app_id": "loan-service", "target_route": "loans/return-payments", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/loans/vendor-disbursements": { "get": { "operationId": "aurax-bff-redirect-get-vendor-disbursement-list", "tags": [ "loans" ], "summary": "aurax-bff-redirect-get-vendor-disbursement-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-vendor-disbursement-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loans/vendor-disbursements", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "InternalVendorId", "declared_type": null, "nullable": true, "collection": false }, { "name": "ExternalVendorId", "declared_type": null, "nullable": true, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "VendorDisbursementDto", "collection": true, "members": [ { "name": "InternalVendorId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ExternalVendorId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "LoanId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-vendor-disbursement-list", "target_dapr_app_id": "loan-service", "target_route": "loans/vendor-disbursements", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-vendor-disbursement-ui-bpmn", "tags": [ "loans" ], "summary": "aurax-bff-redirect-create-vendor-disbursement-ui-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-vendor-disbursement-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loans/vendor-disbursements", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/loans/{id}": { "get": { "operationId": "aurax-bff-redirect-get-loan-by-id", "tags": [ "loans" ], "summary": "aurax-bff-redirect-get-loan-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-loan-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loans/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "LoanDto", "payload": "LoanDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CustomerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ProposalId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CustomerApplicationId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CustomerAccountId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "LoanProductId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "LoanNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FundingSource", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "OrganizationId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Amount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "LoanDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "Status", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ExchangeRate", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "AccountingEntryId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "LoanCloseDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "LoanCloseType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CustomerRiskId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "AllotmentQueryId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ParentLoanId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CancelDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "CancelReason", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CancelDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LatePenaltyRate", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "EarlyPaymentDiscountRate", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "AccrualStatus", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ExternalReference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExternalTransactionid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "VendorExternalId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "StatusContext", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PartnerId", "declared_type": "Guid?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-loan-by-id", "target_dapr_app_id": "loan-service", "target_route": "loans/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LOAN_17", "status": 400, "message": null, "message_available": false, "constant_name": "LOAN_MUST_NOT_BE_NULL" } ] } } }, "/loans/{id}/delegations/{delegationId}": { "get": { "operationId": "aurax-bff-redirect-get-delegation-by-id", "tags": [ "loans" ], "summary": "aurax-bff-redirect-get-delegation-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "delegationId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-delegation-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loans/{id}/delegations/{delegationId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "DelegationId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "LoanDelegationDto", "payload": "LoanDelegationDto", "collection": false, "members": [ { "name": "LoanId", "declared_type": "Guid", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-delegation-by-id", "target_dapr_app_id": "loan-service", "target_route": "loans/{id}/delegations/{delegationId}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LOAN_17", "status": 400, "message": null, "message_available": false, "constant_name": "LOAN_MUST_NOT_BE_NULL" }, { "code": "ERR_LOAN_39", "status": 400, "message": { "ar": "القرض - الوفد غير موجود. المعرف: {0}", "en": "Loan - delegation cannot be found. :{0}", "tr": "Kredi vekaleti bulunamadı. : {0}" }, "message_available": true, "constant_name": "DELEGATION_IS_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-loan-delegation-ui-bpmn", "tags": [ "loans" ], "summary": "aurax-bff-redirect-update-loan-delegation-ui-bpmn", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "delegationId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-loan-delegation-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loans/{id}/delegations/{delegationId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "DelegationId", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeginDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "EndDate", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/loans/{id}/details": { "get": { "operationId": "aurax-bff-redirect-get-loan-details-by-id", "tags": [ "loans" ], "summary": "aurax-bff-redirect-get-loan-details-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-loan-details-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loans/{id}/details", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "LoanDetailsDto", "payload": "LoanDetailsDto", "collection": false, "members": [ { "name": "ChannelType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Id", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CustomerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ProposalId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CustomerApplicationId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CustomerAccountId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "LoanProductId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "LoanNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FundingSource", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "OrganizationId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Amount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "LoanDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "Status", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ExchangeRate", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "AccountingEntryId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "LoanCloseDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "LoanCloseType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CustomerRiskId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "AllotmentQueryId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ParentLoanId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CancelDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "CancelReason", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CancelDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LatePenaltyRate", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "EarlyPaymentDiscountRate", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "AccrualStatus", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ExternalReference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExternalTransactionid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "VendorExternalId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "StatusContext", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PartnerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Disbursements", "declared_type": "List", "nullable": false, "collection": true }, { "name": "PaybackPlans", "declared_type": "List", "nullable": false, "collection": true }, { "name": "CollateralUsages", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Expenses", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Orders", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Delegations", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Guarantors", "declared_type": "List", "nullable": false, "collection": true }, { "name": "ReturnPayments", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Insurances", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Merchants", "declared_type": "List", "nullable": false, "collection": true }, { "name": "PoolDefinitionRates", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-loan-details-by-id", "target_dapr_app_id": "loan-service", "target_route": "loans/{id}/details", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LOAN_17", "status": 400, "message": null, "message_available": false, "constant_name": "LOAN_MUST_NOT_BE_NULL" } ] } } }, "/loans/{id}/expenses": { "get": { "operationId": "aurax-bff-redirect-get-loan-expense-list", "tags": [ "loans" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-loan-expense-list", "description": "Request and response fields are declared on the routing target `get-loan-expense-list`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "loanId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "expenseId": { "type": "string", "format": "uuid", "x-aura-field-code": "expenseId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "loanExpenseId" }, "isInclude": { "type": "boolean", "x-aura-field-code": "isInclude" }, "loanId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-loan-expense-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loans/{id}/expenses", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-loan-expense-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "LoanExpenseDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "LoanId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ExpenseId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "IsInclude", "declared_type": "bool?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LOAN_17", "status": 400, "message": null, "message_available": false, "constant_name": "LOAN_MUST_NOT_BE_NULL" } ] } } }, "/loans/{id}/installments": { "get": { "operationId": "aurax-bff-redirect-get-installment-list-by-id", "tags": [ "loans" ], "summary": "aurax-bff-redirect-get-installment-list-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-installment-list-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loans/{id}/installments", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "List", "envelopes": [ "List" ], "payload": "InstallmentQueryDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "InstallmentNo", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "InstallmentDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "CollectionStatus", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsAccrual", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "InstallmentTotalAmount", "declared_type": "decimal?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/loans/{id}/insurances": { "get": { "operationId": "aurax-bff-redirect-get-insurance-by-loan-id", "tags": [ "loans" ], "summary": "aurax-bff-redirect-get-insurance-by-loan-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-insurance-by-loan-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loans/{id}/insurances", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "InsuranceDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Type", "declared_type": "int", "nullable": false, "collection": false }, { "name": "PolicyNumber", "declared_type": "int", "nullable": false, "collection": false }, { "name": "LoanId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ProductName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Company", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PolicyHolderNumber", "declared_type": "int", "nullable": false, "collection": false }, { "name": "CoverageCurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PolicyHolderFullname", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LossPayee", "declared_type": "string", "nullable": false, "collection": false }, { "name": "VehicleBrand", "declared_type": "string", "nullable": false, "collection": false }, { "name": "VehicleModel", "declared_type": "string", "nullable": false, "collection": false }, { "name": "VehicleType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "EngineNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ChassisNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Plate", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PremiumAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "PremiumCurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CoverageAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "StartDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "EndDate", "declared_type": "DateTime?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-insurance-by-loan-id", "target_dapr_app_id": "loan-service", "target_route": "loans/{id}/insurances", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LOAN_17", "status": 400, "message": null, "message_available": false, "constant_name": "LOAN_MUST_NOT_BE_NULL" } ] } } }, "/loans/{id}/insurances/{insuranceId}": { "get": { "operationId": "aurax-bff-redirect-get-insurance-by-id", "tags": [ "loans" ], "summary": "aurax-bff-redirect-get-insurance-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "insuranceId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-insurance-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loans/{id}/insurances/{insuranceId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "InsuranceId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "InsuranceDto", "payload": "InsuranceDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Type", "declared_type": "int", "nullable": false, "collection": false }, { "name": "PolicyNumber", "declared_type": "int", "nullable": false, "collection": false }, { "name": "LoanId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ProductName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Company", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PolicyHolderNumber", "declared_type": "int", "nullable": false, "collection": false }, { "name": "CoverageCurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PolicyHolderFullname", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LossPayee", "declared_type": "string", "nullable": false, "collection": false }, { "name": "VehicleBrand", "declared_type": "string", "nullable": false, "collection": false }, { "name": "VehicleModel", "declared_type": "string", "nullable": false, "collection": false }, { "name": "VehicleType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "EngineNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ChassisNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Plate", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PremiumAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "PremiumCurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CoverageAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "StartDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "EndDate", "declared_type": "DateTime?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-insurance-by-id", "target_dapr_app_id": "loan-service", "target_route": "loans/{id}/insurances/{insuranceId}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LOAN_17", "status": 400, "message": null, "message_available": false, "constant_name": "LOAN_MUST_NOT_BE_NULL" }, { "code": "ERR_LOAN_95", "status": 400, "message": null, "message_available": false, "constant_name": "LOAN_INSURANCE_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-insurance-bpmn", "tags": [ "loans" ], "summary": "aurax-bff-redirect-update-insurance-bpmn", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "insuranceId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-insurance-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loans/{id}/insurances/{insuranceId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "InsuranceId", "declared_type": null, "nullable": false, "collection": false }, { "name": "Type", "declared_type": null, "nullable": false, "collection": false }, { "name": "PolicyNumber", "declared_type": null, "nullable": true, "collection": false }, { "name": "ProductName", "declared_type": null, "nullable": false, "collection": false }, { "name": "Company", "declared_type": null, "nullable": false, "collection": false }, { "name": "PolicyHolderNumber", "declared_type": null, "nullable": true, "collection": false }, { "name": "CoverageCurrencyNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "PolicyHolderFullname", "declared_type": null, "nullable": false, "collection": false }, { "name": "LossPayee", "declared_type": null, "nullable": false, "collection": false }, { "name": "VehicleBrand", "declared_type": null, "nullable": false, "collection": false }, { "name": "VehicleModel", "declared_type": null, "nullable": false, "collection": false }, { "name": "VehicleType", "declared_type": null, "nullable": false, "collection": false }, { "name": "EngineNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChassisNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "Plate", "declared_type": null, "nullable": false, "collection": false }, { "name": "PremiumAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "PremiumCurrencyNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "CoverageAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "StartDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "EndDate", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/loans/{id}/metal-purchases": { "get": { "operationId": "aurax-bff-redirect-get-metal-puchase-by-loan-id", "tags": [ "loans" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-metal-puchase-by-loan-id", "description": "Request and response fields are declared on the routing target `get-metal-puchase-by-loan-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "loanId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a collection.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-metal-puchase-by-loan-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loans/{id}/metal-purchases", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "LoanMetalPurchaseDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "LoanId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CurrencyId", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UnitPrice", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "Weight", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "GlBalanceId", "declared_type": "Guid?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LOAN_17", "status": 400, "message": null, "message_available": false, "constant_name": "LOAN_MUST_NOT_BE_NULL" } ] } } }, "/loans/{id}/metal-purchases/{metalPurchaseId}": { "get": { "operationId": "aurax-bff-redirect-get-loan-metal-purchase-by-id", "tags": [ "loans" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-loan-metal-purchase-by-id", "description": "Request and response fields are declared on the routing target `get-loan-metal-purchase-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "loanId" } }, { "name": "metalPurchaseId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "metalPurchaseId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 2, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-loan-metal-purchase-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loans/{id}/metal-purchases/{metalPurchaseId}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "MetalPurchaseId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "LoanMetalPurchaseDto", "payload": "LoanMetalPurchaseDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "LoanId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CurrencyId", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UnitPrice", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "Weight", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "GlBalanceId", "declared_type": "Guid?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LOAN_110", "status": 400, "message": null, "message_available": false, "constant_name": "LOAN_METAL_PURCHASE_NOT_FOUND" }, { "code": "ERR_LOAN_17", "status": 400, "message": null, "message_available": false, "constant_name": "LOAN_MUST_NOT_BE_NULL" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-loan-metal-purchase", "tags": [ "loans" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-update-loan-metal-purchase", "description": "Request and response fields are declared on the routing target `update-loan-metal-purchase`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "loanId" } }, { "name": "metalPurchaseId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "metalPurchaseId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "code" }, "currencyId": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyId" }, "glBalanceId": { "type": "string", "format": "uuid", "x-aura-field-code": "glBalanceId" }, "unitPrice": { "type": "number", "format": "decimal", "x-aura-field-code": "unitPrice" }, "weight": { "type": "number", "x-aura-field-code": "weight" } }, "required": [ "code", "currencyId", "glBalanceId", "unitPrice", "weight" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 5, "claim": 0, "form": 0, "header": 0, "path": 2, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-loan-metal-purchase", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loans/{id}/metal-purchases/{metalPurchaseId}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "MetalPurchaseId", "declared_type": null, "nullable": false, "collection": false }, { "name": "CurrencyId", "declared_type": null, "nullable": false, "collection": false }, { "name": "Code", "declared_type": null, "nullable": false, "collection": false }, { "name": "UnitPrice", "declared_type": null, "nullable": false, "collection": false }, { "name": "Weight", "declared_type": null, "nullable": false, "collection": false }, { "name": "GlBalanceId", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LOAN_110", "status": 400, "message": null, "message_available": false, "constant_name": "LOAN_METAL_PURCHASE_NOT_FOUND" }, { "code": "ERR_LOAN_17", "status": 400, "message": null, "message_available": false, "constant_name": "LOAN_MUST_NOT_BE_NULL" } ] } } }, "/loans/{id}/payback-plans": { "get": { "operationId": "aurax-bff-redirect-get-loan-payback-plan-list", "tags": [ "loans" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-loan-payback-plan-list", "description": "Request and response fields are declared on the routing target `get-loan-payback-plan-list`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "loanId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "averageMaturity": { "type": "integer", "format": "int32", "x-aura-field-code": "averageMaturity" }, "compoundInterestRate": { "type": "number", "format": "decimal", "x-aura-field-code": "compoundInterestRate" }, "effectiveInterestRate": { "type": "number", "format": "decimal", "x-aura-field-code": "effectiveInterestRate" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "loanPaybackPlanId" }, "installmentCount": { "type": "integer", "format": "int32", "x-aura-field-code": "installmentCount" }, "installments": { "type": "array", "items": { "type": "object", "properties": { "balloonPaymentAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "balloonPaymentAmount" }, "calculateInstallmentDate": { "type": "string", "format": "date-time", "x-aura-field-code": "calculateInstallmentDate" }, "collectionStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "collectionStatus" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "installmentId" }, "installmentDate": { "type": "string", "format": "date-time", "x-aura-field-code": "installmentDate" }, "installmentNo": { "type": "integer", "format": "int32", "x-aura-field-code": "installmentNo" }, "installmentTotalAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "installmentTotalAmount" }, "isAccrual": { "type": "boolean", "x-aura-field-code": "isAccrual" }, "isManual": { "type": "boolean", "x-aura-field-code": "isManual" }, "loanId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanId" }, "principalAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "principalAmount" }, "profitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "profitAmount" }, "remainingPrincipalAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "remainingPrincipalAmount" }, "taxes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "loanPaybackPlanInstallmentTaxId" }, "taxAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "taxAmount" }, "taxId": { "type": "string", "format": "uuid", "x-aura-field-code": "taxId" } }, "x-aura-field-code": "taxes" } } }, "x-aura-field-code": "installments" } }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "monthlyRate": { "type": "number", "format": "decimal", "x-aura-field-code": "monthlyRate" }, "paybackPlanId": { "type": "string", "format": "uuid", "x-aura-field-code": "paybackPlanId" }, "totalAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "totalAmount" }, "totalPaymentAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "totalPaymentAmount" }, "xirr": { "type": "number", "format": "decimal", "x-aura-field-code": "xirr" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-loan-payback-plan-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loans/{id}/payback-plans", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-loan-payback-plan-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "LoanPaybackPlanDto", "collection": true, "members": [ { "name": "InstallmentCount", "declared_type": "int", "nullable": false, "collection": false }, { "name": "MonthlyRate", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "TotalAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "TotalPaymentAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "Xirr", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "EffectiveInterestRate", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "CompoundInterestRate", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "AverageMaturity", "declared_type": "int", "nullable": false, "collection": false }, { "name": "PaybackPlanId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Installments", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LOAN_17", "status": 400, "message": null, "message_available": false, "constant_name": "LOAN_MUST_NOT_BE_NULL" } ] } } }, "/loans/{id}/return-payment-collection-detail": { "get": { "operationId": "aurax-bff-redirect-get-loan-return-payment-detail-collection-list-by-loan-id", "tags": [ "loans" ], "summary": "aurax-bff-redirect-get-loan-return-payment-detail-collection-list-by-loan-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-loan-return-payment-detail-collection-list-by-loan-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loans/{id}/return-payment-collection-detail", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/loans/{id}/return-payments/{loanReturnPaymentId}": { "get": { "operationId": "aurax-bff-redirect-get-loan-return-payment-detail-by-id", "tags": [ "loans" ], "summary": "aurax-bff-redirect-get-loan-return-payment-detail-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "loanReturnPaymentId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-loan-return-payment-detail-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loans/{id}/return-payments/{loanReturnPaymentId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "LoanReturnPaymentId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/loans/{id}/vendor-disbursements": { "get": { "operationId": "aurax-bff-redirect-get-vendor_disbursements-by-loan-id-query", "tags": [ "loans" ], "summary": "aurax-bff-redirect-get-vendor_disbursements-by-loan-id-query", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-vendor_disbursements-by-loan-id-query", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loans/{id}/vendor-disbursements", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/loans/{id}/vendor-disbursements/{vendorDisbursementId}": { "get": { "operationId": "aurax-bff-redirect-get-vendor-disbursement-by-id", "tags": [ "loans" ], "summary": "aurax-bff-redirect-get-vendor-disbursement-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "vendorDisbursementId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-vendor-disbursement-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "loans/{id}/vendor-disbursements/{vendorDisbursementId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "VendorDisbursementId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "VendorDisbursementDto", "payload": "VendorDisbursementDto", "collection": false, "members": [ { "name": "InternalVendorId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ExternalVendorId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "LoanId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-vendor-disbursement-by-id", "target_dapr_app_id": "loan-service", "target_route": "loans/{id}/vendor-disbursements/{vendorDisbursementId}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LOAN_17", "status": 400, "message": null, "message_available": false, "constant_name": "LOAN_MUST_NOT_BE_NULL" }, { "code": "ERR_LOAN_22", "status": 400, "message": { "ar": "لا يتم العثور على صرف البائع. المعرف:{0}", "en": "Vendor disbursement cannot be found.:{0}", "tr": "Satıcı ödemesi bulunamadı. : {0}" }, "message_available": true, "constant_name": "LOAN_VENDOR_DISBURSEMENT_MUST_NOT_BE_NULL" } ] } } }, "/localization-types": { "get": { "operationId": "aurax-bff-get-localization-type-list", "tags": [ "localization-types" ], "summary": "aurax-bff-get-localization-type-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-get-localization-type-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "localization-types", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/main-prices": { "get": { "operationId": "aurax-bff-get-main-price-list", "tags": [ "main-prices" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-get-main-price-list", "description": "Request and response fields are declared on the routing target `get-main-price-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "channelType": { "type": "integer", "format": "int32", "x-aura-field-code": "channelType" }, "currencyId": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyId" }, "defaultRate": { "type": "number", "format": "decimal", "x-aura-field-code": "defaultRate" }, "domainType": { "type": "integer", "format": "int32", "x-aura-field-code": "domainTypePr" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "mainPriceId" }, "maturity": { "type": "integer", "format": "int32", "x-aura-field-code": "maturity" }, "maxRate": { "type": "number", "format": "decimal", "x-aura-field-code": "maxRate" }, "minRate": { "type": "number", "format": "decimal", "x-aura-field-code": "minRate" }, "productType": { "type": "integer", "format": "int32", "x-aura-field-code": "productType" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-get-main-price-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "main-prices", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-main-price-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "MainPriceDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "DomainType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ProductType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Maturity", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ChannelType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "MinRate", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "MaxRate", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "DefaultRate", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CurrencyId", "declared_type": "int", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } }, "post": { "operationId": "aurax-bff-create-main-price", "tags": [ "main-prices" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-create-main-price", "description": "Request and response fields are declared on the routing target `create-main-price`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "channelType": { "type": "integer", "format": "int32", "x-aura-field-code": "channelType" }, "currencyId": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyId" }, "defaultRate": { "type": "number", "format": "decimal", "x-aura-field-code": "defaultRate" }, "domainType": { "type": "integer", "format": "int32", "x-aura-field-code": "domainTypePr" }, "maturity": { "type": "integer", "format": "int32", "x-aura-field-code": "maturity" }, "maxRate": { "type": "number", "format": "decimal", "x-aura-field-code": "maxRate" }, "minRate": { "type": "number", "format": "decimal", "x-aura-field-code": "minRate" }, "productType": { "type": "integer", "format": "int32", "x-aura-field-code": "productType" } }, "required": [ "channelType", "currencyId", "defaultRate", "domainType", "maturity", "maxRate", "minRate", "productType" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 8, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-create-main-price", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "main-prices", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "DomainType", "declared_type": null, "nullable": false, "collection": false }, { "name": "ProductType", "declared_type": null, "nullable": false, "collection": false }, { "name": "Maturity", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChannelType", "declared_type": null, "nullable": false, "collection": false }, { "name": "MinRate", "declared_type": null, "nullable": false, "collection": false }, { "name": "MaxRate", "declared_type": null, "nullable": false, "collection": false }, { "name": "DefaultRate", "declared_type": null, "nullable": true, "collection": false }, { "name": "CurrencyId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "command-id", "note": "The route returns `AuraCommandDto`, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, `Id`, of type `Guid`. A caller gets a JSON OBJECT with one field, not a bare value. The field is `id` on the wire.", "declared_type": "AuraCommandDto", "envelopes": [ "AuraCommandDto" ], "payload": "Guid", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false, "wire_name": "id", "wire_name_basis": "framework-naming-policy" } ], "naming": "Member names are the service's declaration names.", "synthesized": true }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_PRICING_2", "status": 400, "message": null, "message_available": false, "constant_name": "MAIN_PRICE_ALREADY_EXISTS" } ] } } }, "/main-prices/by-domain/{domainType}": { "get": { "operationId": "aurax-bff-get-main-price-list-by-domain", "tags": [ "main-prices" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-get-main-price-list-by-domain", "description": "Request and response fields are declared on the routing target `get-main-price-list-by-domain`; this entry declares none of its own.", "parameters": [ { "name": "domainType", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "domainTypePr" } }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "channelType": { "type": "integer", "format": "int32", "x-aura-field-code": "channelType" }, "currencyId": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyId" }, "defaultRate": { "type": "number", "format": "decimal", "x-aura-field-code": "defaultRate" }, "domainType": { "type": "integer", "format": "int32", "x-aura-field-code": "domainTypePr" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "mainPriceId" }, "maturity": { "type": "integer", "format": "int32", "x-aura-field-code": "maturity" }, "maxRate": { "type": "number", "format": "decimal", "x-aura-field-code": "maxRate" }, "minRate": { "type": "number", "format": "decimal", "x-aura-field-code": "minRate" }, "productType": { "type": "integer", "format": "int32", "x-aura-field-code": "productType" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-get-main-price-list-by-domain", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "main-prices/by-domain/{domainType}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "DomainType", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "MainPriceDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "DomainType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ProductType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Maturity", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ChannelType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "MinRate", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "MaxRate", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "DefaultRate", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CurrencyId", "declared_type": "int", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/main-prices/{id}": { "delete": { "operationId": "aurax-bff-delete-main-price", "tags": [ "main-prices" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-delete-main-price", "description": "Request and response fields are declared on the routing target `delete-main-price`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "mainPriceId" } } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-delete-main-price", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "main-prices/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_PRICING_1", "status": 400, "message": null, "message_available": false, "constant_name": "MAIN_PRICE_NOT_FOUND" } ] } }, "get": { "operationId": "aurax-bff-get-main-price-by-id", "tags": [ "main-prices" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-get-main-price-by-id", "description": "Request and response fields are declared on the routing target `get-main-price-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "mainPriceId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "channelType": { "type": "integer", "format": "int32", "x-aura-field-code": "channelType" }, "currencyId": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyId" }, "defaultRate": { "type": "number", "format": "decimal", "x-aura-field-code": "defaultRate" }, "domainType": { "type": "integer", "format": "int32", "x-aura-field-code": "domainTypePr" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "mainPriceId" }, "maturity": { "type": "integer", "format": "int32", "x-aura-field-code": "maturity" }, "maxRate": { "type": "number", "format": "decimal", "x-aura-field-code": "maxRate" }, "minRate": { "type": "number", "format": "decimal", "x-aura-field-code": "minRate" }, "productType": { "type": "integer", "format": "int32", "x-aura-field-code": "productType" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-get-main-price-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "main-prices/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "MainPriceDto", "payload": "MainPriceDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "DomainType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ProductType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Maturity", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ChannelType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "MinRate", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "MaxRate", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "DefaultRate", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CurrencyId", "declared_type": "int", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_PRICING_1", "status": 400, "message": null, "message_available": false, "constant_name": "MAIN_PRICE_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-update-main-price", "tags": [ "main-prices" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-update-main-price", "description": "Request and response fields are declared on the routing target `update-main-price`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "mainPriceId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "channelType": { "type": "integer", "format": "int32", "x-aura-field-code": "channelType" }, "currencyId": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyId" }, "defaultRate": { "type": "number", "format": "decimal", "x-aura-field-code": "defaultRate" }, "domainType": { "type": "integer", "format": "int32", "x-aura-field-code": "domainTypePr" }, "maturity": { "type": "integer", "format": "int32", "x-aura-field-code": "maturity" }, "maxRate": { "type": "number", "format": "decimal", "x-aura-field-code": "maxRate" }, "minRate": { "type": "number", "format": "decimal", "x-aura-field-code": "minRate" }, "productType": { "type": "integer", "format": "int32", "x-aura-field-code": "productType" } }, "required": [ "channelType", "currencyId", "defaultRate", "domainType", "maturity", "maxRate", "minRate", "productType" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 8, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-update-main-price", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "main-prices/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "DomainType", "declared_type": null, "nullable": false, "collection": false }, { "name": "ProductType", "declared_type": null, "nullable": false, "collection": false }, { "name": "Maturity", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChannelType", "declared_type": null, "nullable": false, "collection": false }, { "name": "MinRate", "declared_type": null, "nullable": false, "collection": false }, { "name": "MaxRate", "declared_type": null, "nullable": false, "collection": false }, { "name": "DefaultRate", "declared_type": null, "nullable": true, "collection": false }, { "name": "CurrencyId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "UpdateMainPriceDto", "payload": "UpdateMainPriceDto", "collection": false, "members": [ { "name": "IsChanged", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_PRICING_1", "status": 400, "message": null, "message_available": false, "constant_name": "MAIN_PRICE_NOT_FOUND" }, { "code": "ERR_PRICING_2", "status": 400, "message": null, "message_available": false, "constant_name": "MAIN_PRICE_ALREADY_EXISTS" } ] } } }, "/main-products": { "get": { "operationId": "aurax-bff-redirect-get-main-product-list", "tags": [ "main-products" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-main-product-list", "description": "Request and response fields are declared on the routing target `get-main-product-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "code" } }, "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } }, { "name": "productDomainType", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "productDomainType" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 6 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "cashType": { "type": "integer", "format": "int32", "x-aura-field-code": "cashType" }, "code": { "type": "string", "x-aura-field-code": "code" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "isLastLeaf": { "type": "boolean", "x-aura-field-code": "isLastLeaf" }, "name": { "type": "string", "x-aura-field-code": "name", "x-aura-maskable": true }, "parentMainProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "parentMainProductId" }, "productDomainType": { "type": "integer", "format": "int32", "x-aura-field-code": "productDomainType" }, "segmentType": { "type": "integer", "format": "int32", "x-aura-field-code": "segmentType" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-main-product-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "main-products", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-main-product-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "ProductDomainType", "declared_type": null, "nullable": true, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "MainProductDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ParentMainProductId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ProductDomainType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "SegmentType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CashType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsLastLeaf", "declared_type": "bool?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." } }, "post": { "operationId": "aurax-bff-redirect-create-main-product", "tags": [ "main-products" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-create-main-product", "description": "Request and response fields are declared on the routing target `create-main-product`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "cashType": { "type": "integer", "format": "int32", "x-aura-field-code": "cashType" }, "code": { "type": "string", "x-aura-field-code": "code" }, "isLastLeaf": { "type": "boolean", "x-aura-field-code": "isLastLeaf" }, "name": { "type": "string", "x-aura-field-code": "name", "x-aura-maskable": true }, "parentMainProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "parentMainProductId" }, "productDomainType": { "type": "integer", "format": "int32", "x-aura-field-code": "productDomainType" }, "segmentType": { "type": "integer", "format": "int32", "x-aura-field-code": "segmentType" } }, "required": [ "cashType", "code", "isLastLeaf", "name", "productDomainType", "segmentType" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 7, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-main-product", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "main-products", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "ParentMainProductId", "declared_type": null, "nullable": true, "collection": false }, { "name": "ProductDomainType", "declared_type": null, "nullable": false, "collection": false }, { "name": "SegmentType", "declared_type": null, "nullable": false, "collection": false }, { "name": "Code", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "CashType", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsLastLeaf", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "command-id", "note": "The route returns `AuraCommandDto`, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, `Id`, of type `Guid`. A caller gets a JSON OBJECT with one field, not a bare value. The field is `id` on the wire.", "declared_type": "AuraCommandDto", "envelopes": [ "AuraCommandDto" ], "payload": "Guid", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false, "wire_name": "id", "wire_name_basis": "framework-naming-policy" } ], "naming": "Member names are the service's declaration names.", "synthesized": true }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_PRODTREE_2", "status": 400, "message": null, "message_available": false, "constant_name": "MAIN_PRODUCT_CODE_ALREADY_EXISTS" }, { "code": "ERR_PRODTREE_3", "status": 400, "message": null, "message_available": false, "constant_name": "PARENT_MAIN_PRODUCT_NOT_FOUND" }, { "code": "ERR_PRODTREE_5", "status": 400, "message": null, "message_available": false, "constant_name": "PARENT_MAIN_PRODUCT_CANNOT_BE_LAST_LEAF" } ] } } }, "/main-products/by-domain/{productDomainType}": { "get": { "operationId": "aurax-bff-redirect-get-main-product-list-by-domain", "tags": [ "main-products" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-main-product-list-by-domain", "description": "Request and response fields are declared on the routing target `get-main-product-list-by-domain`; this entry declares none of its own.", "parameters": [ { "name": "productDomainType", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "productDomainType" } }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "code" } }, "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "cashType": { "type": "integer", "format": "int32", "x-aura-field-code": "cashType" }, "code": { "type": "string", "x-aura-field-code": "code" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "isLastLeaf": { "type": "boolean", "x-aura-field-code": "isLastLeaf" }, "name": { "type": "string", "x-aura-field-code": "name", "x-aura-maskable": true }, "parentMainProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "parentMainProductId" }, "productDomainType": { "type": "integer", "format": "int32", "x-aura-field-code": "productDomainType" }, "segmentType": { "type": "integer", "format": "int32", "x-aura-field-code": "segmentType" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-main-product-list-by-domain", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "main-products/by-domain/{productDomainType}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "ProductDomainType", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "MainProductDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ParentMainProductId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ProductDomainType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "SegmentType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CashType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsLastLeaf", "declared_type": "bool?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/main-products/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-main-product", "tags": [ "main-products" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-delete-main-product", "description": "Request and response fields are declared on the routing target `delete-main-product`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-main-product", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "main-products/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_PRODTREE_1", "status": 400, "message": null, "message_available": false, "constant_name": "MAIN_PRODUCT_NOT_FOUND" } ] } }, "get": { "operationId": "aurax-bff-redirect-get-main-product-by-id", "tags": [ "main-products" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-main-product-by-id", "description": "Request and response fields are declared on the routing target `get-main-product-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "cashType": { "type": "integer", "format": "int32", "x-aura-field-code": "cashType" }, "code": { "type": "string", "x-aura-field-code": "code" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "isLastLeaf": { "type": "boolean", "x-aura-field-code": "isLastLeaf" }, "name": { "type": "string", "x-aura-field-code": "name", "x-aura-maskable": true }, "parentMainProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "parentMainProductId" }, "productDomainType": { "type": "integer", "format": "int32", "x-aura-field-code": "productDomainType" }, "segmentType": { "type": "integer", "format": "int32", "x-aura-field-code": "segmentType" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-main-product-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "main-products/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "MainProductDto", "payload": "MainProductDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ParentMainProductId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ProductDomainType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "SegmentType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CashType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsLastLeaf", "declared_type": "bool?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_PRODTREE_1", "status": 400, "message": null, "message_available": false, "constant_name": "MAIN_PRODUCT_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-main-product", "tags": [ "main-products" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-update-main-product", "description": "Request and response fields are declared on the routing target `update-main-product`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "cashType": { "type": "integer", "format": "int32", "x-aura-field-code": "cashType" }, "code": { "type": "string", "x-aura-field-code": "code" }, "isLastLeaf": { "type": "boolean", "x-aura-field-code": "isLastLeaf" }, "name": { "type": "string", "x-aura-field-code": "name", "x-aura-maskable": true }, "parentMainProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "parentMainProductId" }, "productDomainType": { "type": "integer", "format": "int32", "x-aura-field-code": "productDomainType" }, "segmentType": { "type": "integer", "format": "int32", "x-aura-field-code": "segmentType" } }, "required": [ "cashType", "code", "isLastLeaf", "name", "productDomainType", "segmentType" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 7, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-main-product", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "main-products/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "ParentMainProductId", "declared_type": null, "nullable": true, "collection": false }, { "name": "ProductDomainType", "declared_type": null, "nullable": false, "collection": false }, { "name": "SegmentType", "declared_type": null, "nullable": false, "collection": false }, { "name": "Code", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "CashType", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsLastLeaf", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_PRODTREE_1", "status": 400, "message": null, "message_available": false, "constant_name": "MAIN_PRODUCT_NOT_FOUND" }, { "code": "ERR_PRODTREE_3", "status": 400, "message": null, "message_available": false, "constant_name": "PARENT_MAIN_PRODUCT_NOT_FOUND" }, { "code": "ERR_PRODTREE_4", "status": 400, "message": null, "message_available": false, "constant_name": "MAIN_PRODUCT_CANNOT_BE_OWN_PARENT" }, { "code": "ERR_PRODTREE_5", "status": 400, "message": null, "message_available": false, "constant_name": "PARENT_MAIN_PRODUCT_CANNOT_BE_LAST_LEAF" }, { "code": "ERR_PRODTREE_6", "status": 400, "message": null, "message_available": false, "constant_name": "LAST_LEAF_CANNOT_HAVE_CHILDREN" } ] } } }, "/mask-formats": { "get": { "operationId": "aurax-bff-redirect-get-mask-format-list", "tags": [ "mask-formats" ], "summary": "aurax-bff-redirect-get-mask-format-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-mask-format-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "mask-formats", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "MaskFormatDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ShowFirst", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ShowLast", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "DefaultMaskLength", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "PreserveLength", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "MaskChar", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RegexPattern", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsSplitBySpace", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-mask-format-list", "target_dapr_app_id": "core-service", "target_route": "mask-formats", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-mask-format", "tags": [ "mask-formats" ], "summary": "aurax-bff-redirect-create-mask-format", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-mask-format", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "mask-formats", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Code", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "ShowFirst", "declared_type": null, "nullable": true, "collection": false }, { "name": "ShowLast", "declared_type": null, "nullable": true, "collection": false }, { "name": "PreserveLength", "declared_type": null, "nullable": false, "collection": false }, { "name": "MaskChar", "declared_type": null, "nullable": false, "collection": false }, { "name": "RegexPattern", "declared_type": null, "nullable": false, "collection": false }, { "name": "DefaultMaskLength", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsSplitBySpace", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "command-id", "note": "The route returns `AuraCommandDto`, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, `Id`, of type `Guid`. A caller gets a JSON OBJECT with one field, not a bare value. The field is `id` on the wire.", "declared_type": "AuraCommandDto", "envelopes": [ "AuraCommandDto" ], "payload": "Guid", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false, "wire_name": "id", "wire_name_basis": "framework-naming-policy" } ], "naming": "Member names are the service's declaration names.", "synthesized": true, "forwarded": { "service_code": "create-mask-format", "target_dapr_app_id": "core-service", "target_route": "mask-formats", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_CORE_140", "status": 400, "message": { "ar": "يوجد بالفعل تنسيق قناع بهذا الرمز.", "en": "There is already a mask format with this code.", "tr": "Bu kod ile bir maskeleme formatı zaten var." }, "message_available": true, "constant_name": "THERE_IS_ALREADY_DEFINEND_MASK_FORMAT_WITH_THIS_CODE" }, { "code": "ERR_CORE_144", "status": 400, "message": { "ar": "يجب أن يكون طول القناع الافتراضي أكبر من 0 إذا كانت خاصية الحفاظ على الطول غير مفعلة", "en": "Default mask length must be greater than 0 if preserve length is false", "tr": "Koruma uzunluğu yok ise varsayılan maske uzunluğu 0dan büyük olmalıdır" }, "message_available": true, "constant_name": "DEFAULT_MASK_LENGTH_CANNOT_NULL" }, { "code": "ERR_CORE_145", "status": 400, "message": { "ar": "يجب أن يكون طول القناع الافتراضي فارغًا إذا كان الحفاظ على الطول صحيحًا", "en": "Default mask length must be null if preserve length is true.", "tr": "Koruma uzunluğu varsa, varsayılan maske uzunluğu boş olmalıdır." }, "message_available": true, "constant_name": "DEFAULT_MASK_LENGTH_MUST_BE_NULL" }, { "code": "ERR_CORE_24", "status": 400, "message": { "ar": "لا يمكن لحقول الرمز أن تحتوي على مسافة.", "en": "Code field cannot contain space.", "tr": "Kod alanı boşluk içeremez." }, "message_available": true, "constant_name": "CODE_FIELD_CANNOT_CONTAIN_SPACE" } ] } } }, "/mask-formats/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-mask-format", "tags": [ "mask-formats" ], "summary": "aurax-bff-redirect-delete-mask-format", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-mask-format", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "mask-formats/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "forwarded": { "service_code": "delete-mask-format", "target_dapr_app_id": "core-service", "target_route": "mask-formats/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_CORE_141", "status": 400, "message": { "ar": "لم يتم العثور على معرف تنسيق القناع.", "en": "Mask format cannot be found.", "tr": "Maske biçimi bulunamadı." }, "message_available": true, "constant_name": "MASK_FORMAT_ID_NOT_FOUND" } ] } }, "get": { "operationId": "aurax-bff-redirect-get-mask-format-by-id", "tags": [ "mask-formats" ], "summary": "aurax-bff-redirect-get-mask-format-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-mask-format-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "mask-formats/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "MaskFormatDto", "payload": "MaskFormatDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ShowFirst", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ShowLast", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "DefaultMaskLength", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "PreserveLength", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "MaskChar", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RegexPattern", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsSplitBySpace", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-mask-format-by-id", "target_dapr_app_id": "core-service", "target_route": "mask-formats/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_CORE_141", "status": 400, "message": { "ar": "لم يتم العثور على معرف تنسيق القناع.", "en": "Mask format cannot be found.", "tr": "Maske biçimi bulunamadı." }, "message_available": true, "constant_name": "MASK_FORMAT_ID_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-mask-format", "tags": [ "mask-formats" ], "summary": "aurax-bff-redirect-update-mask-format", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-mask-format", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "mask-formats/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "ShowFirst", "declared_type": null, "nullable": true, "collection": false }, { "name": "ShowLast", "declared_type": null, "nullable": true, "collection": false }, { "name": "PreserveLength", "declared_type": null, "nullable": false, "collection": false }, { "name": "MaskChar", "declared_type": null, "nullable": false, "collection": false }, { "name": "RegexPattern", "declared_type": null, "nullable": false, "collection": false }, { "name": "DefaultMaskLength", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsSplitBySpace", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "forwarded": { "service_code": "update-mask-format", "target_dapr_app_id": "core-service", "target_route": "mask-formats/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_CORE_141", "status": 400, "message": { "ar": "لم يتم العثور على معرف تنسيق القناع.", "en": "Mask format cannot be found.", "tr": "Maske biçimi bulunamadı." }, "message_available": true, "constant_name": "MASK_FORMAT_ID_NOT_FOUND" }, { "code": "ERR_CORE_144", "status": 400, "message": { "ar": "يجب أن يكون طول القناع الافتراضي أكبر من 0 إذا كانت خاصية الحفاظ على الطول غير مفعلة", "en": "Default mask length must be greater than 0 if preserve length is false", "tr": "Koruma uzunluğu yok ise varsayılan maske uzunluğu 0dan büyük olmalıdır" }, "message_available": true, "constant_name": "DEFAULT_MASK_LENGTH_CANNOT_NULL" }, { "code": "ERR_CORE_145", "status": 400, "message": { "ar": "يجب أن يكون طول القناع الافتراضي فارغًا إذا كان الحفاظ على الطول صحيحًا", "en": "Default mask length must be null if preserve length is true.", "tr": "Koruma uzunluğu varsa, varsayılan maske uzunluğu boş olmalıdır." }, "message_available": true, "constant_name": "DEFAULT_MASK_LENGTH_MUST_BE_NULL" } ] } } }, "/matrix/results/by-product-id/{accountProductId}": { "get": { "operationId": "aurax-bff-redirect-account-get-matrix-result-value", "tags": [ "matrix" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-account-get-matrix-result-value", "x-aura-incomplete-contract": { "note": "Presence of this extension means the request and response schemas on this operation are known to be incomplete. Absence means no declared field was dropped for this reason — it is not a claim that the catalog is otherwise complete." }, "description": "INCOMPLETE CONTRACT. The catalog declares 2 request field(s) that this document could NOT place and does not show: the catalog parents this field to a row belonging to a DIFFERENT service, so it is a child of a node that is not part of this contract. So the properties and any `required` array below are a SUBSET of what the catalog declares, not the whole of it. They are dropped rather than re-attached because placing them would mean guessing which node they belong under, and this document does not guess. See `x-aura-incomplete-contract` for the field names.", "parameters": [ { "name": "accountProductId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductId" } }, { "name": "columnValues", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "object", "x-aura-field-code": "columnValues" } } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": false, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 1 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "This usage type is outside the invocation layer's filtered set, so that layer applies no binding-source filter at all and every declared source is passed through.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-account-get-matrix-result-value", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "matrix/results/by-product-id/{accountProductId}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/menus": { "get": { "operationId": "aurax-bff-redirect-aurax-management-get-menu-definition-list", "tags": [ "menus" ], "summary": "aurax-bff-redirect-aurax-management-get-menu-definition-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-aurax-management-get-menu-definition-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "menus", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "MenuDefinitionDetailDto", "collection": true, "members": [ { "name": "ParentMenuDefinitionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "IconName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SortOrder", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Form", "declared_type": "MenuFormDefinitionDto", "nullable": false, "collection": false }, { "name": "Children", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "aurax-management-get-menu-definition-list", "target_dapr_app_id": "aurax-management-service", "target_route": "menus", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-aurax-management-create-menu-definition", "tags": [ "menus" ], "summary": "aurax-bff-redirect-aurax-management-create-menu-definition", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-aurax-management-create-menu-definition", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "menus", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/menus/{id}": { "delete": { "operationId": "aurax-bff-redirect-aurax-management-delete-menu-definition", "tags": [ "menus" ], "summary": "aurax-bff-redirect-aurax-management-delete-menu-definition", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-aurax-management-delete-menu-definition", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "menus/{id}", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "get": { "operationId": "aurax-bff-redirect-aurax-management-get-menu-definition-by-id", "tags": [ "menus" ], "summary": "aurax-bff-redirect-aurax-management-get-menu-definition-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-aurax-management-get-menu-definition-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "menus/{id}", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "MenuDefinitionDto", "payload": "MenuDefinitionDto", "collection": false, "members": [ { "name": "ParentMenuDefinitionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "IconName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SortOrder", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Translations", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "aurax-management-get-menu-definition-by-id", "target_dapr_app_id": "aurax-management-service", "target_route": "menus/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_FRMCTL_3", "status": 400, "message": null, "message_available": false, "constant_name": "MENU_DEFINITION_ID_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-aurax-management-update-menu-definition", "tags": [ "menus" ], "summary": "aurax-bff-redirect-aurax-management-update-menu-definition", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-aurax-management-update-menu-definition", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "menus/{id}", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/money-transfer-to-other-account": { "post": { "operationId": "aurax-bff-service-dynamic-money-transfer-to-other-account-BPM", "tags": [ "money-transfer-to-other-account" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-money-transfer-to-other-account-BPM", "description": "Request and response fields are declared on the routing target `money-transfer-to-other-account-BPM`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "cashTransactionType": { "type": "integer", "format": "int32", "x-aura-field-code": "cashTransactionType" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "description": { "type": "string", "x-aura-field-code": "description" }, "fromAccountId": { "type": "string", "format": "uuid", "x-aura-field-code": "fromAccountId" }, "paymentPurpose": { "type": "integer", "format": "int32", "x-aura-field-code": "paymentPurpose" }, "toAccountId": { "type": "string", "format": "uuid", "x-aura-field-code": "toAccountId" } }, "required": [ "amount", "cashTransactionType", "currencyNumber", "fromAccountId", "paymentPurpose", "toAccountId" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 7, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-money-transfer-to-other-account-BPM", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "money-transfer-to-other-account", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/money-transfer-to-other-bank": { "post": { "operationId": "aurax-bff-service-dynamic-outgoing-transfer-ui-bpm", "tags": [ "money-transfer-to-other-bank" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-outgoing-transfer-ui-bpm", "description": "Request and response fields are declared on the routing target `outgoing-transfer-ui-bpm`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "content": { "type": "string", "x-aura-field-code": "content" }, "description": { "type": "string", "x-aura-field-code": "description" }, "doFast": { "type": "boolean", "x-aura-field-code": "doFast" }, "easyAddressRef": { "type": "string", "x-aura-field-code": "easyAddressRef" }, "fromIban": { "type": "string", "x-aura-field-code": "fromIban" }, "paymentPurpose": { "type": "integer", "format": "int32", "x-aura-field-code": "paymentPurpose" }, "processDate": { "type": "string", "format": "date-time", "x-aura-field-code": "transferDate" }, "toIban": { "type": "string", "x-aura-field-code": "toIban" }, "toOwner": { "type": "string", "x-aura-field-code": "toOwner" } }, "required": [ "amount", "fromIban", "paymentPurpose", "processDate", "toIban", "toOwner" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 10, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-outgoing-transfer-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "money-transfer-to-other-bank", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/money-transfer-to-own-account": { "post": { "operationId": "aurax-bff-service-dynamic-money-transfer-to-own-account-BPM", "tags": [ "money-transfer-to-own-account" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-money-transfer-to-own-account-BPM", "description": "Request and response fields are declared on the routing target `money-transfer-to-own-account-BPM`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "cashTransactionType": { "type": "integer", "format": "int32", "x-aura-field-code": "cashTransactionType" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "description": { "type": "string", "x-aura-field-code": "description" }, "fromAccountId": { "type": "string", "format": "uuid", "x-aura-field-code": "fromAccountId" }, "operationType": { "type": "integer", "format": "int32", "x-aura-field-code": "operationType" }, "toAccountId": { "type": "string", "format": "uuid", "x-aura-field-code": "toAccountId" } }, "required": [ "amount", "cashTransactionType", "currencyNumber", "fromAccountId", "operationType", "toAccountId" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 7, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-money-transfer-to-own-account-BPM", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "money-transfer-to-own-account", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/naces": { "get": { "operationId": "aurax-bff-redirect-get-nace-list", "tags": [ "naces" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-nace-list", "description": "Request and response fields are declared on the routing target `get-nace-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "naceCode" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "naceId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "levelNo": { "type": "integer", "format": "int32", "x-aura-field-code": "levelNo" }, "parentNaceId": { "type": "string", "format": "uuid", "x-aura-field-code": "parentNaceId" }, "riskClass": { "type": "integer", "format": "int32", "x-aura-field-code": "riskClass" }, "translations": { "type": "array", "items": { "type": "object", "properties": { "languageCode": { "type": "string", "x-aura-field-code": "languageCode" }, "name": { "type": "string", "x-aura-field-code": "naceName" } }, "x-aura-field-code": "translations" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-nace-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "naces", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-nace-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/naces/by-nace-id/{parentNaceId}": { "get": { "operationId": "aurax-bff-redirect-get-sector-code-by-parent-nace-id", "tags": [ "naces" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-sector-code-by-parent-nace-id", "description": "Request and response fields are declared on the routing target `get-sector-code-by-parent-nace-id`; this entry declares none of its own.", "parameters": [ { "name": "parentNaceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "parentNaceId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "naceCode" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "naceId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "levelNo": { "type": "integer", "format": "int32", "x-aura-field-code": "levelNo" }, "parentNaceId": { "type": "string", "format": "uuid", "x-aura-field-code": "parentNaceId" }, "riskClass": { "type": "integer", "format": "int32", "x-aura-field-code": "riskClass" }, "translations": { "type": "array", "items": { "type": "object", "properties": { "languageCode": { "type": "string", "x-aura-field-code": "languageCode" }, "name": { "type": "string", "x-aura-field-code": "naceName" } }, "x-aura-field-code": "translations" } } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-sector-code-by-parent-nace-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "naces/by-nace-id/{parentNaceId}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/naces/{id}": { "get": { "operationId": "aurax-bff-redirect-get-nace-by-id", "tags": [ "naces" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-nace-by-id", "description": "Request and response fields are declared on the routing target `get-nace-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "naceId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "naceCode" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "naceId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "levelNo": { "type": "integer", "format": "int32", "x-aura-field-code": "levelNo" }, "parentNaceId": { "type": "string", "format": "uuid", "x-aura-field-code": "parentNaceId" }, "riskClass": { "type": "integer", "format": "int32", "x-aura-field-code": "riskClass" }, "translations": { "type": "array", "items": { "type": "object", "properties": { "languageCode": { "type": "string", "x-aura-field-code": "languageCode" }, "name": { "type": "string", "x-aura-field-code": "naceName" } }, "x-aura-field-code": "translations" } } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-nace-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "naces/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/occupation-types": { "get": { "operationId": "aurax-bff-dynamic-get-occupation-type-list", "tags": [ "occupation-types" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-occupation-type-list", "description": "Request and response fields are declared on the routing target `get-occupation-type-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 1 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "occupationTypeCode" }, "dataType": { "type": "integer", "format": "int32", "x-aura-field-code": "dataType" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "occupationTypeId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "isMandatory": { "type": "boolean", "x-aura-field-code": "isMandatory" }, "isMultiple": { "type": "boolean", "x-aura-field-code": "isMultiple" }, "isTextable": { "type": "boolean", "x-aura-field-code": "IsTextable" }, "name": { "type": "string", "x-aura-field-code": "occupationTypeName" }, "occupationTypeFields": { "type": "array", "items": { "type": "object", "properties": { "fieldKey": { "type": "string", "x-aura-field-code": "occupationTypeFieldKey" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "occupationTypeFieldId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "sequenceNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "sequenceNumber" }, "translations": { "type": "array", "items": { "type": "object", "properties": { "languageCode": { "type": "string", "x-aura-field-code": "languageCode" }, "name": { "type": "string", "x-aura-field-code": "translations_name" } }, "x-aura-field-code": "translations" } }, "typeId": { "type": "string", "format": "uuid", "x-aura-field-code": "occupationTypeId" } }, "x-aura-field-code": "occupationTypeFields" } }, "parentOccupationTypeId": { "type": "string", "format": "uuid", "x-aura-field-code": "parentOccupationTypeId" }, "sortOrder": { "type": "number", "x-aura-field-code": "sortOrder" }, "translations": { "type": "array", "items": { "type": "object", "properties": { "languageCode": { "type": "string", "x-aura-field-code": "languageCode" }, "name": { "type": "string", "x-aura-field-code": "translations_name" } }, "x-aura-field-code": "translations" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-occupation-type-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "occupation-types", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-occupation-type-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "post": { "operationId": "aurax-bff-dynamic-create-occupation-type-template-bpm", "tags": [ "occupation-types" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "create-occupation-type-template-bpm", "description": "Invokes the `aurax-bff-dynamic-create-occupation-type-template-bpm` service definition through `POST /occupation-types`.\n\nTurkish display name: adres tip tanımalrını siler \n\nRequest and response fields are declared on the routing target `create-occupation-type-template-bpm`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "occupationTypeCode" }, "dataType": { "type": "integer", "format": "int32", "x-aura-field-code": "dataType" }, "isMandatory": { "type": "boolean", "x-aura-field-code": "isMandatory" }, "isMultiple": { "type": "boolean", "x-aura-field-code": "isMultiple" }, "isTextable": { "type": "boolean", "x-aura-field-code": "IsTextable" }, "name": { "type": "string", "x-aura-field-code": "occupationTypeName" }, "occupationTypeFields": { "type": "array", "items": { "type": "object", "properties": { "fieldKey": { "type": "string", "x-aura-field-code": "occupationTypeFieldKey" }, "relatedOccupationTypeFieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "relatedOccupationTypeFieldId" }, "sequenceNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "sequenceNumber" } }, "x-aura-field-code": "occupationTypeFields" } }, "parentOccupationTypeId": { "type": "string", "format": "uuid", "x-aura-field-code": "parentOccupationTypeId" }, "sortOrder": { "type": "number", "x-aura-field-code": "sortOrder" } }, "required": [ "code", "isMandatory", "name" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 9, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-create-occupation-type-template-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "occupation-types", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/occupation-types/{id}": { "delete": { "operationId": "aurax-bff-dynamic-delete-occupation-type-definition", "tags": [ "occupation-types" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "delete occupation type definition", "description": "Invokes the `aurax-bff-dynamic-delete-occupation-type-definition` service definition through `DELETE /occupation-types/{id}`.\n\nRequest and response fields are declared on the routing target `delete-occupation-type-definition`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in this route template but not among the Route-bound fields of the routing target `delete-occupation-type-definition`, whose own path is decoupled from this one.", "x-aura-source": "route-template-only-after-collapse" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "occupationTypeId" } }, "required": [ "id" ] } } }, "description": "The catalog declares Body-bound fields on this DELETE operation. Request bodies on DELETE have no defined semantics in HTTP; this documents the catalog, not a recommendation. Not every field below is accepted: the platform selects which of them this operation admits and drops the rest. Of the fields below, the binder does not admit `id`, which this document nevertheless marks required because the catalog declares it so.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [ "body" ], "dropped_field_names": { "body": [ "id" ] }, "dropped_mandatory_field_names": [ "id" ], "verdict": "declared-fields-not-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": "The HTTP edge in front of this operation comes in two shapes and they differ: the platform's typed route readers bind GET and DELETE from the URL and never read a body, while its untyped catalog-redirect reader collects the body whenever the request carries one. It does not change the answer above: the selection below happens after the edge, and excludes these fields either way." }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-delete-occupation-type-definition", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "occupation-types/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "get": { "operationId": "aurax-bff-dynamic-get-occupation-type-by-id", "tags": [ "occupation-types" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-occupation-type-by-id", "description": "Request and response fields are declared on the routing target `get-occupation-type-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "occupationTypeId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "occupationTypeCode" }, "dataType": { "type": "integer", "format": "int32", "x-aura-field-code": "dataType" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "occupationTypeId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "isMandatory": { "type": "boolean", "x-aura-field-code": "isMandatory" }, "isMultiple": { "type": "boolean", "x-aura-field-code": "isMultiple" }, "isTextable": { "type": "boolean", "x-aura-field-code": "IsTextable" }, "name": { "type": "string", "x-aura-field-code": "occupationTypeName" }, "occupationTypeFields": { "type": "array", "items": { "type": "object", "properties": { "fieldKey": { "type": "string", "x-aura-field-code": "occupationTypeFieldKey" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "occupationTypeFieldId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "sequenceNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "sequenceNumber" }, "translations": { "type": "array", "items": { "type": "object", "properties": { "languageCode": { "type": "string", "x-aura-field-code": "languageCode" }, "name": { "type": "string", "x-aura-field-code": "translations_name" } }, "x-aura-field-code": "translations" } }, "typeId": { "type": "string", "format": "uuid", "x-aura-field-code": "occupationTypeId" } }, "x-aura-field-code": "occupationTypeFields" } }, "parentOccupationTypeId": { "type": "string", "format": "uuid", "x-aura-field-code": "parentOccupationTypeId" }, "sortOrder": { "type": "number", "x-aura-field-code": "sortOrder" }, "translations": { "type": "array", "items": { "type": "object", "properties": { "languageCode": { "type": "string", "x-aura-field-code": "languageCode" }, "name": { "type": "string", "x-aura-field-code": "translations_name" } }, "x-aura-field-code": "translations" } } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-occupation-type-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "occupation-types/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "put": { "operationId": "aurax-bff-dynamic-update-occupation-type-template-bpm", "tags": [ "occupation-types" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "update-occupation-type-template-bpm", "description": "Invokes the `aurax-bff-dynamic-update-occupation-type-template-bpm` service definition through `PUT /occupation-types/{id}`.\n\nTurkish display name: meslek tipi alanlarını günceller \n\nRequest and response fields are declared on the routing target `update-occupation-type-template-bpm`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in this route template but not among the Route-bound fields of the routing target `update-occupation-type-template-bpm`, whose own path is decoupled from this one.", "x-aura-source": "route-template-only-after-collapse" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "occupationTypeCode" }, "dataType": { "type": "integer", "format": "int32", "x-aura-field-code": "dataType" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "occupationTypeId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "isMandatory": { "type": "boolean", "x-aura-field-code": "isMandatory" }, "isMultiple": { "type": "boolean", "x-aura-field-code": "isMultiple" }, "isTextable": { "type": "boolean", "x-aura-field-code": "IsTextable" }, "name": { "type": "string", "x-aura-field-code": "occupationTypeName" }, "occupationTypeFields": { "type": "array", "items": { "type": "object", "properties": { "fieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "occupationTypeFieldId" }, "fieldKey": { "type": "string", "x-aura-field-code": "occupationTypeFieldKey" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "sequenceNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "sequenceNumber" }, "typeId": { "type": "string", "format": "uuid", "x-aura-field-code": "occupationTypeId" } }, "x-aura-field-code": "occupationTypeFields" } }, "parentOccupationTypeId": { "type": "string", "format": "uuid", "x-aura-field-code": "parentOccupationTypeId" }, "sortOrder": { "type": "number", "x-aura-field-code": "sortOrder" } }, "required": [ "code", "id", "isActive", "isMandatory", "name" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 11, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-update-occupation-type-template-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "occupation-types/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/occupation-types/{id}/fields": { "get": { "operationId": "aurax-bff-dynamic-get-occupation-type-field-list", "tags": [ "occupation-types" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-occupation-type-field-list", "description": "Request and response fields are declared on the routing target `get-occupation-type-field-list`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "occupationTypeId" } }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 3 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "fieldKey": { "type": "string", "x-aura-field-code": "occupationTypeFieldKey" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "occupationTypeFieldId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "sequenceNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "sequenceNumber" }, "translations": { "type": "array", "items": { "type": "object", "properties": { "languageCode": { "type": "string", "x-aura-field-code": "languageCode" }, "name": { "type": "string", "x-aura-field-code": "translations_name" } }, "x-aura-field-code": "translations" } }, "typeId": { "type": "string", "format": "uuid", "x-aura-field-code": "occupationTypeId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-occupation-type-field-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "occupation-types/{id}/fields", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "note": "Platform-provided behaviours declared on the routing target `get-occupation-type-field-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/occupation-types/{id}/fields/{fieldId}": { "delete": { "operationId": "aurax-bff-redirect-delete-occupation-type-field", "tags": [ "occupation-types" ], "summary": "aurax-bff-redirect-delete-occupation-type-field", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "fieldId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-occupation-type-field", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "occupation-types/{id}/fields/{fieldId}", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/occupation-types/{id}/fields/{fieldId}/maps": { "get": { "operationId": "aurax-bff-dynamic-get-occupation-type-field-map-list", "tags": [ "occupation-types" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-occupation-type-field-map-list", "description": "Request and response fields are declared on the routing target `get-occupation-type-field-map-list`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "occupationTypeId" } }, { "name": "fieldId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "occupationTypeFieldId" } }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } }, { "name": "targetOccupationTypeId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "targetOccupationTypeId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 2, "query": 6 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "occupationTypeFieldMapId" }, "sourceOccupationTypeFieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "sourceOccupationTypeFieldId" }, "targetOccupationTypeFieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "targetOccupationTypeFieldId" }, "targetOccupationTypeFieldKey": { "type": "string", "x-aura-field-code": "targetOccupationTypeFieldKey" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-occupation-type-field-map-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "occupation-types/{id}/fields/{fieldId}/maps", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-occupation-type-field-map-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "post": { "operationId": "aurax-bff-redirect-create-occupation-type-field-map", "tags": [ "occupation-types" ], "summary": "aurax-bff-redirect-create-occupation-type-field-map", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "fieldId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-occupation-type-field-map", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "occupation-types/{id}/fields/{fieldId}/maps", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/occupation-types/{id}/fields/{fieldId}/maps/{mapId}": { "delete": { "operationId": "aurax-bff-redirect-delete-occupation-type-field-map", "tags": [ "occupation-types" ], "summary": "aurax-bff-redirect-delete-occupation-type-field-map", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "fieldId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "mapId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-occupation-type-field-map", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "occupation-types/{id}/fields/{fieldId}/maps/{mapId}", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "get": { "operationId": "aurax-bff-redirect-get-occupation-type-field-map-by-id", "tags": [ "occupation-types" ], "summary": "aurax-bff-redirect-get-occupation-type-field-map-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "fieldId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "mapId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-occupation-type-field-map-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "occupation-types/{id}/fields/{fieldId}/maps/{mapId}", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "put": { "operationId": "aurax-bff-redirect-update-occupation-type-field-map", "tags": [ "occupation-types" ], "summary": "aurax-bff-redirect-update-occupation-type-field-map", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "fieldId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "mapId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-occupation-type-field-map", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "occupation-types/{id}/fields/{fieldId}/maps/{mapId}", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/organizations": { "get": { "operationId": "aurax-bff-redirect-get-organization-list", "tags": [ "organizations" ], "summary": "aurax-bff-redirect-get-organization-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-organization-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "organizations", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrganizationCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "OrganizationDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ParentId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Path", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-organization-list", "target_dapr_app_id": "core-service", "target_route": "organizations", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/organizations/{realm}/groups": { "get": { "operationId": "aurax-bff-redirect-get-organization-group-list", "tags": [ "organizations" ], "summary": "aurax-bff-redirect-get-organization-group-list", "parameters": [ { "name": "realm", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-organization-group-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "organizations/{realm}/groups", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "post": { "operationId": "aurax-bff-redirect-create-organization-bpm", "tags": [ "organizations" ], "summary": "aurax-bff-redirect-create-organization-bpm", "parameters": [ { "name": "realm", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-organization-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "organizations/{realm}/groups", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/organizations/{realm}/groups/{groupId}": { "delete": { "operationId": "aurax-bff-redirect-delete-organization-bpm", "tags": [ "organizations" ], "summary": "aurax-bff-redirect-delete-organization-bpm", "parameters": [ { "name": "realm", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-organization-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "organizations/{realm}/groups/{groupId}", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "get": { "operationId": "aurax-bff-redirect-get-organization-by-id", "tags": [ "organizations" ], "summary": "aurax-bff-redirect-get-organization-by-id", "parameters": [ { "name": "realm", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-organization-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "organizations/{realm}/groups/{groupId}", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "put": { "operationId": "aurax-bff-redirect-update-organization-bpm", "tags": [ "organizations" ], "summary": "aurax-bff-redirect-update-organization-bpm", "parameters": [ { "name": "realm", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-organization-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "organizations/{realm}/groups/{groupId}", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/organizations/{realm}/groups/{groupId}/members": { "get": { "operationId": "aurax-bff-redirect-get-organization-members-list", "tags": [ "organizations" ], "summary": "aurax-bff-redirect-get-organization-members-list", "parameters": [ { "name": "realm", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-organization-members-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "organizations/{realm}/groups/{groupId}/members", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "unresolved", "note": "This route is registered through the custom-response forwarder, whose single generic argument is the RESPONSE type rather than the request. This portal's endpoint parser assigns the first generic to the request for every builder, so the type is recorded against the wrong side and is not read back here. That is a defect in this portal, named rather than hidden, and the type is present in the source." } } }, "/organizations/{realm}/groups/{groupId}/role-mappings/realm": { "get": { "operationId": "aurax-bff-redirect-get-realm-role-list-for-organization", "tags": [ "organizations" ], "summary": "aurax-bff-redirect-get-realm-role-list-for-organization", "parameters": [ { "name": "realm", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-realm-role-list-for-organization", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "organizations/{realm}/groups/{groupId}/role-mappings/realm", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/organizations/{realm}/groups/{groupId}/role-mappings/realm/available": { "get": { "operationId": "aurax-bff-redirect-get-available-realm-role-list-for-group", "tags": [ "organizations" ], "summary": "aurax-bff-redirect-get-available-realm-role-list-for-group", "parameters": [ { "name": "realm", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-available-realm-role-list-for-group", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "organizations/{realm}/groups/{groupId}/role-mappings/realm/available", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/organizations/{realm}/users/by-code/{userCode}/details": { "get": { "operationId": "aurax-bff-redirect-get-user-manager-detail-by-code", "tags": [ "organizations" ], "summary": "aurax-bff-redirect-get-user-manager-detail-by-code", "parameters": [ { "name": "realm", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "userCode", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-user-manager-detail-by-code", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "organizations/{realm}/users/by-code/{userCode}/details", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/organizations/{realm}/users/details": { "get": { "operationId": "aurax-bff-redirect-get-user-detail-list", "tags": [ "organizations" ], "summary": "aurax-bff-redirect-get-user-detail-list", "parameters": [ { "name": "realm", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-user-detail-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "organizations/{realm}/users/details", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/otp-items": { "get": { "operationId": "aurax-bff-redirect-get-otp-item-list", "tags": [ "otp-items" ], "summary": "aurax-bff-redirect-get-otp-item-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-otp-item-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "otp-items", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "OtpItemDto", "collection": true, "members": [ { "name": "KeyFormatId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ValidityDuration", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "RetryDuration", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "RetryCount", "declared_type": "int", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-otp-item-list", "target_dapr_app_id": "business-core-service", "target_route": "otp-items", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-otp-item-create-ui-bpm", "tags": [ "otp-items" ], "summary": "aurax-bff-redirect-otp-item-create-ui-bpm", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-otp-item-create-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "otp-items", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "KeyFormatId", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "ValidityDuration", "declared_type": null, "nullable": true, "collection": false }, { "name": "RetryDuration", "declared_type": null, "nullable": true, "collection": false }, { "name": "RetryCount", "declared_type": null, "nullable": false, "collection": false }, { "name": "KycValidatityDuration", "declared_type": null, "nullable": false, "collection": false }, { "name": "UnconfirmedTimeWindow", "declared_type": null, "nullable": true, "collection": false }, { "name": "MaxUnconfirmedCount", "declared_type": null, "nullable": true, "collection": false }, { "name": "LockoutDuration", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/otp-items/by-transaction-id/{transactionId}/retry": { "get": { "operationId": "aurax-bff-redirect-get-otp-retry-by-transaction-id", "tags": [ "otp-items" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-otp-retry-by-transaction-id", "description": "Request and response fields are declared on the routing target `get-otp-retry-by-transaction-id`; this entry declares none of its own.", "parameters": [ { "name": "transactionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "transactionId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-otp-retry-by-transaction-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "otp-items/by-transaction-id/{transactionId}/retry", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "TransactionId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "declared-non-dto", "note": "The route returns `bool`, a scalar rather than an object. There is no field tree below because there are no fields: the body is the JSON literal `true` or `false`. This is a complete answer read from the declaration, not a gap.", "declared_type": "bool", "payload": "bool" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_OTP_4", "status": 400, "message": null, "message_available": false, "constant_name": "OTP_TRANSACTION_IS_NOT_FOUND" } ] } } }, "/otp-items/{id}": { "delete": { "operationId": "aurax-bff-redirect-otp-item-delete-ui-bpm", "tags": [ "otp-items" ], "summary": "aurax-bff-redirect-otp-item-delete-ui-bpm", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-otp-item-delete-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "otp-items/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "get": { "operationId": "aurax-bff-redirect-get-otp-item-by-id", "tags": [ "otp-items" ], "summary": "aurax-bff-redirect-get-otp-item-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-otp-item-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "otp-items/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "OtpItemDto", "payload": "OtpItemDto", "collection": false, "members": [ { "name": "KeyFormatId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ValidityDuration", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "RetryDuration", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "RetryCount", "declared_type": "int", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-otp-item-by-id", "target_dapr_app_id": "business-core-service", "target_route": "otp-items/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_OTP_2", "status": 400, "message": null, "message_available": false, "constant_name": "OTP_ITEM_IS_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-otp-item-edit-ui-bpm", "tags": [ "otp-items" ], "summary": "aurax-bff-redirect-otp-item-edit-ui-bpm", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-otp-item-edit-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "otp-items/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "KeyFormatId", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "ValidityDuration", "declared_type": null, "nullable": true, "collection": false }, { "name": "RetryDuration", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": null, "nullable": false, "collection": false }, { "name": "retryCount", "declared_type": null, "nullable": false, "collection": false }, { "name": "KycValidityDuration", "declared_type": null, "nullable": true, "collection": false }, { "name": "UnconfirmedTimeWindow", "declared_type": null, "nullable": true, "collection": false }, { "name": "MaxUnconfirmedCount", "declared_type": null, "nullable": true, "collection": false }, { "name": "LockoutDuration", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/otp-items/{id}/by-transaction-id/{transactionId}/confirm-otp": { "post": { "operationId": "aurax-bff-redirect-confirm-otp-by-transaction-id", "tags": [ "otp-items" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-confirm-otp-by-transaction-id", "description": "Request and response fields are declared on the routing target `confirm-otp-by-transaction-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } }, { "name": "transactionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "transactionId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "oneTimePassword": { "type": "string", "x-aura-field-code": "oneTimePassword", "x-aura-encrypted": true } }, "required": [ "oneTimePassword" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 2, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "isConfirmed": { "type": "boolean", "x-aura-field-code": "isConfirmed" }, "phoneNumber": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "isConfirmed": { "type": "boolean", "x-aura-field-code": "isConfirmed" }, "phoneNumber": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "isConfirmed": { "type": "boolean", "x-aura-field-code": "isConfirmed" }, "phoneNumber": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-confirm-otp-by-transaction-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "otp-items/{id}/by-transaction-id/{transactionId}/confirm-otp", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionId", "declared_type": null, "nullable": false, "collection": false }, { "name": "OneTimePassword", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_OTP_12", "status": 400, "message": null, "message_available": false, "constant_name": "OTP_TRANSACTION_ALREADY_CONFIRMED" }, { "code": "ERR_OTP_4", "status": 400, "message": null, "message_available": false, "constant_name": "OTP_TRANSACTION_IS_NOT_FOUND" }, { "code": "ERR_OTP_8", "status": 400, "message": null, "message_available": false, "constant_name": "OTP_HAS_EXPIRED" }, { "code": "ERR_OTP_9", "status": 400, "message": null, "message_available": false, "constant_name": "OTP_IS_INVALID" } ] } } }, "/otp-items/{id}/by-transaction-id/{transactionId}/retry-confirm-otp": { "post": { "operationId": "aurax-bff-redirect-confirm-otp-retry-by-transaction", "tags": [ "otp-items" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-confirm-otp-retry-by-transaction", "description": "Request and response fields are declared on the routing target `confirm-otp-retry-by-transaction`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "x-aura-type": "unresolved" } }, { "name": "transactionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "transactionId" } } ], "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 2, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-confirm-otp-retry-by-transaction", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "otp-items/{id}/by-transaction-id/{transactionId}/retry-confirm-otp", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_OTP_12", "status": 400, "message": null, "message_available": false, "constant_name": "OTP_TRANSACTION_ALREADY_CONFIRMED" }, { "code": "ERR_OTP_13", "status": 400, "message": { "ar": "يوجد بالفعل رمز OTP نشط. التاريخ النهائي: {0}", "en": "There is already active OTP. endDate:{0}", "tr": "Aktif OTP bulunmaktadır. endDate:{0}" }, "message_available": true, "constant_name": "OTP_HAS_EXPIRED_RETRY" }, { "code": "ERR_OTP_2", "status": 400, "message": null, "message_available": false, "constant_name": "OTP_ITEM_IS_NOT_FOUND" }, { "code": "ERR_OTP_4", "status": 400, "message": null, "message_available": false, "constant_name": "OTP_TRANSACTION_IS_NOT_FOUND" } ] } } }, "/otp-items/{id}/transactions": { "post": { "operationId": "aurax-bff-redirect-create-otp-transaction", "tags": [ "otp-items" ], "summary": "aurax-bff-redirect-create-otp-transaction", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-otp-transaction", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "otp-items/{id}/transactions", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "PhoneNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "Email", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "CreateOtpTransactionDto", "payload": "CreateOtpTransactionDto", "collection": false, "members": [ { "name": "OneTimePassword", "declared_type": "string", "nullable": false, "collection": false }, { "name": "EndDate", "declared_type": "DateTime?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "create-otp-transaction", "target_dapr_app_id": "business-core-service", "target_route": "otp-items/{id}/transactions", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_OTP_15", "status": 400, "message": null, "message_available": false, "constant_name": "EMAIL_IS_INVALID" }, { "code": "ERR_OTP_2", "status": 400, "message": null, "message_available": false, "constant_name": "OTP_ITEM_IS_NOT_FOUND" }, { "code": "ERR_OTP_3", "status": 400, "message": null, "message_available": false, "constant_name": "OTP_ITEM_MUST_NOT_BE_PASSIVE" }, { "code": "ERR_OTP_6", "status": 400, "message": null, "message_available": false, "constant_name": "KEY_FORMAT_MUST_NOT_BE_NULL" }, { "code": "ERR_OTP_7", "status": 400, "message": null, "message_available": false, "constant_name": "KEY_FORMAT_MUST_NOT_BE_PASSIVE" } ] } } }, "/outgoing-distraint-files": { "get": { "operationId": "aurax-bff-dynamic-get-outgoing-distraint-file-list", "tags": [ "outgoing-distraint-files" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-outgoing-distraint-file-list", "description": "Request and response fields are declared on the routing target `get-outgoing-distraint-file-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a collection.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-outgoing-distraint-file-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "outgoing-distraint-files", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-outgoing-distraint-file-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "OutgoingDistraintFileDto", "collection": true, "members": [ { "name": "PackageCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IncomingDistraintFileId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Status", "declared_type": "int", "nullable": false, "collection": false }, { "name": "PackageDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "StatusSourceOffice", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "StatusSourceOfficeDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Details", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/outgoing-distraint-files/{id}": { "get": { "operationId": "aurax-bff-dynamic-get-outgoing-distraint-file-by-id", "tags": [ "outgoing-distraint-files" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-outgoing-distraint-file-by-id", "description": "Request and response fields are declared on the routing target `get-outgoing-distraint-file-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-outgoing-distraint-file-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "outgoing-distraint-files/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "OutgoingDistraintFileDto", "payload": "OutgoingDistraintFileDto", "collection": false, "members": [ { "name": "PackageCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IncomingDistraintFileId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Status", "declared_type": "int", "nullable": false, "collection": false }, { "name": "PackageDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "StatusSourceOffice", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "StatusSourceOfficeDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Details", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCNT_167", "status": 400, "message": null, "message_available": false, "constant_name": "OUTGOING_DISTRAINT_FILE_NOT_FOUND" } ] } } }, "/outgoing-distraint-files/{id}/details": { "get": { "operationId": "aurax-bff-dynamic-get-outgoing-distraint-file-detail-list", "tags": [ "outgoing-distraint-files" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-outgoing-distraint-file-detail-list", "description": "Request and response fields are declared on the routing target `get-outgoing-distraint-file-detail-list`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a collection.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-outgoing-distraint-file-detail-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "outgoing-distraint-files/{id}/details", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-outgoing-distraint-file-detail-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "OutgoingDistraintFileDetailDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "DistraintNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TaxOfficeCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TaxNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Surname", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FatherName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Amount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "BirthDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "HasAvailableAccount", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "CurrencyId", "declared_type": "int?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/outgoing-distraint-files/{id}/details/{outgoingDistraintFileDetailId}/salaries": { "get": { "operationId": "aurax-bff-dynamic-get-outgoing-distraint-file-salary-list", "tags": [ "outgoing-distraint-files" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-outgoing-distraint-file-salary-list", "description": "Request and response fields are declared on the routing target `get-outgoing-distraint-file-salary-list`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } }, { "name": "outgoingDistraintFileDetailId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "outgoingDistraintFileDetailId" } }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 2, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a collection.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-outgoing-distraint-file-salary-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "outgoing-distraint-files/{id}/details/{outgoingDistraintFileDetailId}/salaries", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-outgoing-distraint-file-salary-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "OutgoingDistraintFileSalaryDto", "collection": true, "members": [ { "name": "OutgoingDistraintFileDetailId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OrganizationId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "SalaryType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "SalaryAmount", "declared_type": "decimal?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/outgoing-letter-of-guarantees": { "get": { "operationId": "aurax-bff-redirect-get-letter-of-guarantees-list", "tags": [ "outgoing-letter-of-guarantees" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-letter-of-guarantees-list", "description": "Request and response fields are declared on the routing target `get-outgoing-letter-of-guarantees-list`; this entry declares none of its own.", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-letter-of-guarantees-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "outgoing-letter-of-guarantees", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-outgoing-letter-of-guarantees-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Filter", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "OutgoingLetterOfGuaranteeDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "BranchCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Reference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Account", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GuaranteeTypeCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "LetterTypeCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "GuaranteeCurrencyCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "GuaranteeAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "GuaranteeExpiryTypeCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "GuaranteeExpiryDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "GuaranteeSubject", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RequestedBankBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryAddress", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryCountry", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FirstCounterBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SecondCounterGuarantorBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ThirdCounterGuarantorBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GuarantorBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FirstConfirmationBankBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SecondConfirmationBankBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FirstAdvisingBankBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SecondAdvisingBankBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CommissionRatio", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CommissionAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CommissionCurrencyCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CommissionTypeCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "NumberOfPeriods", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "PeriodicalAmountToBePaid", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "NonConvertibleCurrency", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "DirectGuaranteeTypeCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "StandByCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CounterGuaranteeExpiryType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CounterGuaranteeExpiryDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "PurposeOfMessageCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "DateOfIssue", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "FormOfUndertakingCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "UndertakingApplicableRuleTypeCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "UndertakingApplicableRuleNarrative", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExpiryConditionEventCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "AvailableWithBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AvailableWithBankNameAndAddress", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ConfirmationCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "RequestedConfirmationPartyBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GoverningLawJurisdictionCountryCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GoverningLawJurisdictionCountrySubDivision", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GoverningLawJurisdictionNarrative", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DocumentAndPresentationInstructions", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TermsAndConditions", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LocalRequestedDateOfIssue", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "LocalFormOfUndertaking", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LocalUndertakingApplicableRuleTypeCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "LocalUndertakingApplicableRuleNarrative", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LocalExpiryType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LocalDateOfExpiry", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "LocalExpiryConditionEvent", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LocalUndertakingAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "LocalUndertakingCurrency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IssuerBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IssuerBankNameAndAddress", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LocalUndertakingTermsAndConditions", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UnderlyingTransactionDetails", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CreatedDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "ModifiedDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "BranchName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerNumber", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } }, "post": { "operationId": "aurax-bff-redirect-create-outgoing-letter-of-guarantee", "tags": [ "outgoing-letter-of-guarantees" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-create-outgoing-letter-of-guarantee", "description": "Request and response fields are declared on the routing target `outgoing-letter-of-guarantee-create-bpm`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "model": { "type": "object", "x-aura-field-code": "model" } }, "required": [ "model" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-outgoing-letter-of-guarantee", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "outgoing-letter-of-guarantees", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Model", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/outgoing-letter-of-guarantees/preview-mt760": { "post": { "operationId": "aurax-bff-redirect-preview-mt-outgoing-letter-of-guarantees", "tags": [ "outgoing-letter-of-guarantees" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-preview-mt-outgoing-letter-of-guarantees", "description": "Request and response fields are declared on the routing target `preview-mt-outgoing-letter-of-guarantees`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "model": { "type": "object", "x-aura-field-code": "model" } }, "required": [ "model" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-preview-mt-outgoing-letter-of-guarantees", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "outgoing-letter-of-guarantees/preview-mt760", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Model", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "PreviewMT760Response", "payload": "PreviewMT760Response", "collection": false, "members": [ { "name": "MessageType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MessageText", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsValid", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "Errors", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Warnings", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." } } }, "/outgoing-letter-of-guarantees/{id}": { "get": { "operationId": "aurax-bff-redirect-get-outgoing-letter-of-guarantees-by-id", "tags": [ "outgoing-letter-of-guarantees" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-outgoing-letter-of-guarantees-by-id", "description": "Request and response fields are declared on the routing target `get-outgoing-letter-of-guararntee-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "guidField" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-outgoing-letter-of-guarantees-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "outgoing-letter-of-guarantees/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "OutgoingLetterOfGuaranteeDto", "payload": "OutgoingLetterOfGuaranteeDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "BranchCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Reference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Account", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GuaranteeTypeCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "LetterTypeCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "GuaranteeCurrencyCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "GuaranteeAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "GuaranteeExpiryTypeCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "GuaranteeExpiryDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "GuaranteeSubject", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RequestedBankBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryAddress", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryCountry", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FirstCounterBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SecondCounterGuarantorBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ThirdCounterGuarantorBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GuarantorBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FirstConfirmationBankBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SecondConfirmationBankBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FirstAdvisingBankBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SecondAdvisingBankBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CommissionRatio", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CommissionAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CommissionCurrencyCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CommissionTypeCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "NumberOfPeriods", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "PeriodicalAmountToBePaid", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "NonConvertibleCurrency", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "DirectGuaranteeTypeCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "StandByCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CounterGuaranteeExpiryType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CounterGuaranteeExpiryDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "PurposeOfMessageCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "DateOfIssue", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "FormOfUndertakingCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "UndertakingApplicableRuleTypeCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "UndertakingApplicableRuleNarrative", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExpiryConditionEventCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "AvailableWithBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AvailableWithBankNameAndAddress", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ConfirmationCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "RequestedConfirmationPartyBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GoverningLawJurisdictionCountryCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GoverningLawJurisdictionCountrySubDivision", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GoverningLawJurisdictionNarrative", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DocumentAndPresentationInstructions", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TermsAndConditions", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LocalRequestedDateOfIssue", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "LocalFormOfUndertaking", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LocalUndertakingApplicableRuleTypeCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "LocalUndertakingApplicableRuleNarrative", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LocalExpiryType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LocalDateOfExpiry", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "LocalExpiryConditionEvent", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LocalUndertakingAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "LocalUndertakingCurrency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IssuerBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IssuerBankNameAndAddress", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LocalUndertakingTermsAndConditions", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UnderlyingTransactionDetails", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CreatedDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "ModifiedDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "BranchName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerNumber", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_FRGN_TRD_78", "status": 400, "message": null, "message_available": false, "constant_name": "OUTGOING_LETTER_OF_GUARANTEE_NOT_FOUND" } ] } } }, "/parameters/by-code/{code}": { "get": { "operationId": "aurax-bff-redirect-foreign-trade-get-parameter-by-code", "tags": [ "parameters" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-foreign-trade-get-parameter-by-code", "description": "Request and response fields are declared on the routing target `foreign-trade-get-parameter-by-code`; this entry declares none of its own.", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "code" } }, { "name": "includeInactive", "in": "query", "required": false, "schema": { "type": "boolean", "x-aura-field-code": "includeInactive" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 1 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-foreign-trade-get-parameter-by-code", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "parameters/by-code/{code}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "route-claimed-by-two-repositories", "note": "Two services register this method and path, so this portal cannot say which one's request fields these would be. The fields a caller sends are exactly what would differ between them, so nothing is published rather than one of the two." }, "x-aura-code-response": { "state": "structure", "declared_type": "ParameterDto", "payload": "ParameterDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Translations", "declared_type": "IEnumerable", "nullable": false, "collection": true }, { "name": "ParameterFields", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_PRMTR_12", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_CODE_NOT_FOUND" } ] } } }, "/partners": { "get": { "operationId": "aurax-bff-redirect-get-partner-list", "tags": [ "partners" ], "summary": "aurax-bff-redirect-get-partner-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-partner-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "partners", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "PartnerDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Config", "declared_type": "Dictionary", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "ChannelDefinitionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Email", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PhoneNumber", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-partner-list", "target_dapr_app_id": "business-core-service", "target_route": "partners", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-partner", "tags": [ "partners" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-create-partner", "description": "Request and response fields are declared on the routing target `create-partner-bpm`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "channelDefinitionId": { "type": "string", "format": "uuid", "x-aura-field-code": "channelDefinitionId" }, "code": { "type": "string", "x-aura-field-code": "partnerCode" }, "config": { "type": "string", "x-aura-field-code": "partnerCommandConfig" }, "description": { "type": "string", "x-aura-field-code": "description" }, "email": { "type": "string", "x-aura-field-code": "email" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "name": { "type": "string", "x-aura-field-code": "partnerName" }, "phoneNumber": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true } }, "required": [ "code", "email", "isActive", "name", "phoneNumber" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 8, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-partner", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "partners", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Code", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "Config", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChannelDefinitionId", "declared_type": null, "nullable": true, "collection": false }, { "name": "Email", "declared_type": null, "nullable": false, "collection": false }, { "name": "PhoneNumber", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/partners/by-code/{code}": { "get": { "operationId": "aurax-bff-redirect-get-partner-by-code", "tags": [ "partners" ], "summary": "aurax-bff-redirect-get-partner-by-code", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-partner-by-code", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "partners/by-code/{code}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Code", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "PartnerDto", "payload": "PartnerDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Config", "declared_type": "Dictionary", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "ChannelDefinitionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Email", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PhoneNumber", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-partner-by-code", "target_dapr_app_id": "business-core-service", "target_route": "partners/by-code/{code}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_CORE_160", "status": 400, "message": { "ar": "لم يتم العثور على معرف الشريك", "en": "Partner cannot be found.", "tr": "İş ortağı bulunamadı." }, "message_available": true, "constant_name": "PartnerIsNotFound" } ] } } }, "/partners/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-partner", "tags": [ "partners" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-delete-partner", "description": "Request and response fields are declared on the routing target `delete-partner-bpm`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "partnerId" } } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-partner", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "partners/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "get": { "operationId": "aurax-bff-redirect-get-partner-by-id", "tags": [ "partners" ], "summary": "aurax-bff-redirect-get-partner-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-partner-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "partners/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "PartnerDto", "payload": "PartnerDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Config", "declared_type": "Dictionary", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "ChannelDefinitionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Email", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PhoneNumber", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-partner-by-id", "target_dapr_app_id": "business-core-service", "target_route": "partners/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_CORE_160", "status": 400, "message": { "ar": "لم يتم العثور على معرف الشريك", "en": "Partner cannot be found.", "tr": "İş ortağı bulunamadı." }, "message_available": true, "constant_name": "PartnerIsNotFound" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-partner", "tags": [ "partners" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-update-partner", "description": "Request and response fields are declared on the routing target `update-partner-bpm`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "partnerId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "channelDefinitionId": { "type": "string", "format": "uuid", "x-aura-field-code": "channelDefinitionId" }, "code": { "type": "string", "x-aura-field-code": "partnerCode" }, "config": { "type": "string", "x-aura-field-code": "partnerCommandConfig" }, "description": { "type": "string", "x-aura-field-code": "description" }, "email": { "type": "string", "x-aura-field-code": "email" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "name": { "type": "string", "x-aura-field-code": "partnerName" }, "phoneNumber": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true } }, "required": [ "code", "email", "isActive", "name", "phoneNumber" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 8, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-partner", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "partners/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "Config", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChannelDefinitionId", "declared_type": null, "nullable": true, "collection": false }, { "name": "Email", "declared_type": null, "nullable": false, "collection": false }, { "name": "PhoneNumber", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/password-policies": { "get": { "operationId": "aurax-bff-redirect-get-password-policy-list", "tags": [ "password-policies" ], "summary": "aurax-bff-redirect-get-password-policy-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-password-policy-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "password-policies", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "PasswordPolicyDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "UserType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "MinDigitRequired", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "MinLength", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "MinSpecialLetter", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "MinUppercaseLetter", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "MinLowercaseLetter", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "MaxLength", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "RestrictSequentialNumber", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "SequentialNumberCharacterCount", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "RestrictRepeating", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "MaxRepeatingCount", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CheckPasswordHistory", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "PasswordHistoryCount", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "RestrictBirthDate", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "RestrictCustomerNumber", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "RestrictCitizenId", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "RestrictSameNumber", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "MaxSameNumberCount", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "RestrictSequentialArray", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "SequentialArrayCharacterCount", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "RestrictMobileKeyboardNumber", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-password-policy-list", "target_dapr_app_id": "core-service", "target_route": "password-policies", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-password-policy", "tags": [ "password-policies" ], "summary": "aurax-bff-redirect-create-password-policy", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-password-policy", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "password-policies", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "UserType", "declared_type": null, "nullable": false, "collection": false }, { "name": "MinDigitRequired", "declared_type": null, "nullable": true, "collection": false }, { "name": "MinLength", "declared_type": null, "nullable": true, "collection": false }, { "name": "MinSpecialLetter", "declared_type": null, "nullable": true, "collection": false }, { "name": "MinUppercaseLetter", "declared_type": null, "nullable": true, "collection": false }, { "name": "MinLowercaseLetter", "declared_type": null, "nullable": true, "collection": false }, { "name": "MaxLength", "declared_type": null, "nullable": true, "collection": false }, { "name": "RestrictSequentialNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "SequentialNumberCharacterCount", "declared_type": null, "nullable": true, "collection": false }, { "name": "RestrictRepeating", "declared_type": null, "nullable": false, "collection": false }, { "name": "MaxRepeatingCount", "declared_type": null, "nullable": true, "collection": false }, { "name": "CheckPasswordHistory", "declared_type": null, "nullable": false, "collection": false }, { "name": "PasswordHistoryCount", "declared_type": null, "nullable": true, "collection": false }, { "name": "RestrictBirthDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "RestrictCustomerNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "RestrictCitizenId", "declared_type": null, "nullable": false, "collection": false }, { "name": "RestrictSameNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "MaxSameNumberCount", "declared_type": null, "nullable": true, "collection": false }, { "name": "RestrictSequentialArray", "declared_type": null, "nullable": false, "collection": false }, { "name": "SequentialArrayCharacterCount", "declared_type": null, "nullable": true, "collection": false }, { "name": "RestrictMobileKeyboardNumber", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "declared_type": "Unit", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "payload": "Unit", "forwarded": { "service_code": "create-password-policy", "target_dapr_app_id": "core-service", "target_route": "password-policies", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_CORE_163", "status": 400, "message": { "ar": "يوجد بالفعل سياسة كلمة مرور لهذا النوع من المستخدمين", "en": "There is already ap password policy for this user type.", "tr": "Bu kullanıcı türü için ap şifre politikası zaten var." }, "message_available": true, "constant_name": "THERE_IS_ALREADY_A_PASSWORD_POLICY_THIS_USERTYPE" } ] } } }, "/password-policies/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-password-policy", "tags": [ "password-policies" ], "summary": "aurax-bff-redirect-delete-password-policy", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-password-policy", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "password-policies/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "forwarded": { "service_code": "delete-password-policy", "target_dapr_app_id": "core-service", "target_route": "password-policies/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_CORE_164", "status": 400, "message": { "ar": "لم يتم العثور على معرف سياسة كلمة المرور", "en": "Password Policy cannot be found.", "tr": "Parola İlkesi bulunamadı." }, "message_available": true, "constant_name": "PASSWORD_POLICY_ID_IS_NOT_FOUND" } ] } }, "get": { "operationId": "aurax-bff-redirect-get-password-policy-by-id", "tags": [ "password-policies" ], "summary": "aurax-bff-redirect-get-password-policy-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-password-policy-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "password-policies/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "PasswordPolicyDto", "payload": "PasswordPolicyDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "UserType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "MinDigitRequired", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "MinLength", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "MinSpecialLetter", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "MinUppercaseLetter", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "MinLowercaseLetter", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "MaxLength", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "RestrictSequentialNumber", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "SequentialNumberCharacterCount", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "RestrictRepeating", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "MaxRepeatingCount", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CheckPasswordHistory", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "PasswordHistoryCount", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "RestrictBirthDate", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "RestrictCustomerNumber", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "RestrictCitizenId", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "RestrictSameNumber", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "MaxSameNumberCount", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "RestrictSequentialArray", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "SequentialArrayCharacterCount", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "RestrictMobileKeyboardNumber", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-password-policy-by-id", "target_dapr_app_id": "core-service", "target_route": "password-policies/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_CORE_164", "status": 400, "message": { "ar": "لم يتم العثور على معرف سياسة كلمة المرور", "en": "Password Policy cannot be found.", "tr": "Parola İlkesi bulunamadı." }, "message_available": true, "constant_name": "PASSWORD_POLICY_ID_IS_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-password-policy", "tags": [ "password-policies" ], "summary": "aurax-bff-redirect-update-password-policy", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-password-policy", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "password-policies/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "UserType", "declared_type": null, "nullable": false, "collection": false }, { "name": "MinDigitRequired", "declared_type": null, "nullable": true, "collection": false }, { "name": "MinLength", "declared_type": null, "nullable": true, "collection": false }, { "name": "MinSpecialLetter", "declared_type": null, "nullable": true, "collection": false }, { "name": "MinUppercaseLetter", "declared_type": null, "nullable": true, "collection": false }, { "name": "MinLowercaseLetter", "declared_type": null, "nullable": true, "collection": false }, { "name": "MaxLength", "declared_type": null, "nullable": true, "collection": false }, { "name": "RestrictSequentialNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "SequentialNumberCharacterCount", "declared_type": null, "nullable": true, "collection": false }, { "name": "RestrictRepeating", "declared_type": null, "nullable": false, "collection": false }, { "name": "MaxRepeatingCount", "declared_type": null, "nullable": true, "collection": false }, { "name": "CheckPasswordHistory", "declared_type": null, "nullable": false, "collection": false }, { "name": "PasswordHistoryCount", "declared_type": null, "nullable": true, "collection": false }, { "name": "RestrictBirthDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "RestrictCustomerNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "RestrictCitizenId", "declared_type": null, "nullable": false, "collection": false }, { "name": "RestrictSameNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "MaxSameNumberCount", "declared_type": null, "nullable": true, "collection": false }, { "name": "RestrictSequentialArray", "declared_type": null, "nullable": false, "collection": false }, { "name": "SequentialArrayCharacterCount", "declared_type": null, "nullable": true, "collection": false }, { "name": "RestrictMobileKeyboardNumber", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "forwarded": { "service_code": "update-password-policy", "target_dapr_app_id": "core-service", "target_route": "password-policies/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_CORE_163", "status": 400, "message": { "ar": "يوجد بالفعل سياسة كلمة مرور لهذا النوع من المستخدمين", "en": "There is already ap password policy for this user type.", "tr": "Bu kullanıcı türü için ap şifre politikası zaten var." }, "message_available": true, "constant_name": "THERE_IS_ALREADY_A_PASSWORD_POLICY_THIS_USERTYPE" }, { "code": "ERR_CORE_164", "status": 400, "message": { "ar": "لم يتم العثور على معرف سياسة كلمة المرور", "en": "Password Policy cannot be found.", "tr": "Parola İlkesi bulunamadı." }, "message_available": true, "constant_name": "PASSWORD_POLICY_ID_IS_NOT_FOUND" } ] } } }, "/payback-plans": { "get": { "operationId": "aurax-bff-redirect-get-payback-plan-list", "tags": [ "payback-plans" ], "summary": "aurax-bff-redirect-get-payback-plan-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-payback-plan-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "payback-plans", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Filter", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "PaybackPlanDto", "collection": true, "members": [ { "name": "PaybackPlanNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Amount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "InstallmentCount", "declared_type": "int", "nullable": false, "collection": false }, { "name": "MonthlyRepaymentRate", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "TotalPaymentAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "Irr", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "Xirr", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "EffectiveInterestRate", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "CompoundInterestRate", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "PaybackPlanMethod", "declared_type": "int", "nullable": false, "collection": false }, { "name": "PostponedInstallmentCount", "declared_type": "int", "nullable": false, "collection": false }, { "name": "DayDifferentInstallment", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DayInYearCount", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FirstInstallmentDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "PaymentDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "AverageMaturity", "declared_type": "int", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-payback-plan-list", "target_dapr_app_id": "payback-plan-service", "target_route": "payback-plans", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-payback-plan-ui-bpmn", "tags": [ "payback-plans" ], "summary": "aurax-bff-redirect-create-payback-plan-ui-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-payback-plan-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "payback-plans", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Amount", "declared_type": null, "nullable": false, "collection": false }, { "name": "InstallmentCount", "declared_type": null, "nullable": true, "collection": false }, { "name": "PostponedInstallmentCount", "declared_type": null, "nullable": false, "collection": false }, { "name": "PaybackPlanMethod", "declared_type": null, "nullable": false, "collection": false }, { "name": "MonthlyRepaymentRate", "declared_type": null, "nullable": false, "collection": false }, { "name": "DayDifferentInstallment", "declared_type": null, "nullable": false, "collection": false }, { "name": "DayInYearCount", "declared_type": null, "nullable": false, "collection": false }, { "name": "TotalPaymentAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "IRR", "declared_type": null, "nullable": false, "collection": false }, { "name": "XIRR", "declared_type": null, "nullable": false, "collection": false }, { "name": "EffectiveInterestRate", "declared_type": null, "nullable": false, "collection": false }, { "name": "CompoundInterestRate", "declared_type": null, "nullable": false, "collection": false }, { "name": "FirstInstallmentDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "PaymentDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "AverageMaturity", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/payback-plans/calculate": { "post": { "operationId": "aurax-bff-redirect-calculate-generic-payback-plan-ui-bpmn", "tags": [ "payback-plans" ], "summary": "aurax-bff-redirect-calculate-generic-payback-plan-ui-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-calculate-generic-payback-plan-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "payback-plans/calculate", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PaybackPlanMethod", "declared_type": null, "nullable": true, "collection": false }, { "name": "DayInYearCount", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExpenseAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "TotalExpenseAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "AnnualInterestRate", "declared_type": null, "nullable": true, "collection": false }, { "name": "TermInDays", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/payback-plans/create": { "post": { "operationId": "aurax-bff-redirect-create-loan-general-bpmn", "tags": [ "payback-plans" ], "summary": "aurax-bff-redirect-create-loan-general-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-loan-general-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "payback-plans/create", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/payback-plans/{id}": { "get": { "operationId": "aurax-bff-redirect-get-payback-plan-details-by-id", "tags": [ "payback-plans" ], "summary": "aurax-bff-redirect-get-payback-plan-details-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-payback-plan-details-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "payback-plans/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "PaybackPlanDetailsDto", "payload": "PaybackPlanDetailsDto", "collection": false, "members": [ { "name": "Taxes", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Installments", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-payback-plan-details-by-id", "target_dapr_app_id": "payback-plan-service", "target_route": "payback-plans/{id}/details", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_PYBCKPLAN_3", "status": 400, "message": { "ar": "خطة السداد غير موجودة. المعرف:{0}.", "en": "Payback plan cannot be found. :{0}.", "tr": "Geri ödeme planı bulunamadı. : {0}." }, "message_available": true, "constant_name": "PAYBACK_PLAN_MUST_NOT_BE_NULL" } ] } } }, "/permissions/{clientId}/policies/by-subject-id": { "get": { "operationId": "get-client-permission-list-by-subject-id", "tags": [ "permissions" ], "summary": "get-client-permission-list-by-subject-id", "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "clientId" } }, { "name": "organizationId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "organizationId" } }, { "name": "roleId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "roleId" } }, { "name": "userId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "userId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 3 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "resourceId": { "x-aura-type": "unresolved" }, "scopes": { "x-aura-type": "unresolved" }, "type": { "x-aura-type": "unresolved" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-client-permission-list-by-subject-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "permissions/{clientId}/policies/by-subject-id", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "ClientId", "declared_type": null, "nullable": false, "collection": false }, { "name": "UserId", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrganizationId", "declared_type": null, "nullable": true, "collection": false }, { "name": "RoleId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "PermissionDto", "collection": true, "members": [ { "name": "ResourceId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Type", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Scopes", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." } } }, "/person-address-registrations": { "post": { "operationId": "aurax-bff-service-dynamic-person-address-control-bpm", "tags": [ "person-address-registrations" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-person-address-control-bpm", "description": "Request and response fields are declared on the routing target `person-address-control-bpm`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "birthDate": { "type": "string", "format": "date", "x-aura-field-code": "birthDate" }, "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "citizenidType": { "type": "integer", "format": "int32", "x-aura-field-code": "citizenidType" }, "queryDayNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "queryDayNumber" }, "queryType": { "type": "integer", "format": "int32", "x-aura-field-code": "queryType" } }, "required": [ "birthDate", "citizenid", "citizenidType", "queryType" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 5, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "addressNumber": { "type": "string", "x-aura-field-code": "personAddressNumber", "x-aura-maskable": true }, "addressOpenText": { "type": "string", "x-aura-field-code": "addressOpenText", "x-aura-maskable": true }, "addressType": { "type": "integer", "format": "int32", "x-aura-field-code": "addressType" }, "birthDate": { "type": "string", "format": "date", "x-aura-field-code": "birthDate" }, "building": { "type": "string", "x-aura-field-code": "building", "x-aura-maskable": true }, "buildingCode": { "type": "string", "x-aura-field-code": "personAddressBuildingCode" }, "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "city": { "type": "string", "x-aura-field-code": "city", "x-aura-maskable": true }, "cityCode": { "type": "string", "x-aura-field-code": "personAddressCityCode" }, "correlationid": { "type": "string", "format": "uuid", "x-aura-field-code": "correlationid" }, "country": { "type": "string", "x-aura-field-code": "personAddressCountry" }, "countryId": { "type": "integer", "format": "int32", "x-aura-field-code": "countryId" }, "district": { "type": "string", "x-aura-field-code": "district", "x-aura-maskable": true }, "districtCode": { "type": "string", "x-aura-field-code": "personAddressDistrictCode" }, "externalServiceResultId": { "type": "string", "format": "uuid", "x-aura-field-code": "externalServiceResultId" }, "foreignAddress": { "type": "string", "x-aura-field-code": "foreignAddress" }, "neihgbourhood": { "type": "string", "x-aura-field-code": "neihgbourhood", "x-aura-maskable": true }, "neihgbourhoodCode": { "type": "string", "x-aura-field-code": "personNeihgbourhoodCode" }, "region": { "type": "string", "x-aura-field-code": "region" }, "regionCode": { "type": "string", "x-aura-field-code": "personAddressRegionCode" }, "section": { "type": "string", "x-aura-field-code": "section" }, "sectionCode": { "type": "string", "x-aura-field-code": "personAddressSectionCode" }, "street": { "type": "string", "x-aura-field-code": "street", "x-aura-maskable": true }, "streetCode": { "type": "string", "x-aura-field-code": "personAddressStreetCode" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "addressNumber": { "type": "string", "x-aura-field-code": "personAddressNumber", "x-aura-maskable": true }, "addressOpenText": { "type": "string", "x-aura-field-code": "addressOpenText", "x-aura-maskable": true }, "addressType": { "type": "integer", "format": "int32", "x-aura-field-code": "addressType" }, "birthDate": { "type": "string", "format": "date", "x-aura-field-code": "birthDate" }, "building": { "type": "string", "x-aura-field-code": "building", "x-aura-maskable": true }, "buildingCode": { "type": "string", "x-aura-field-code": "personAddressBuildingCode" }, "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "city": { "type": "string", "x-aura-field-code": "city", "x-aura-maskable": true }, "cityCode": { "type": "string", "x-aura-field-code": "personAddressCityCode" }, "correlationid": { "type": "string", "format": "uuid", "x-aura-field-code": "correlationid" }, "country": { "type": "string", "x-aura-field-code": "personAddressCountry" }, "countryId": { "type": "integer", "format": "int32", "x-aura-field-code": "countryId" }, "district": { "type": "string", "x-aura-field-code": "district", "x-aura-maskable": true }, "districtCode": { "type": "string", "x-aura-field-code": "personAddressDistrictCode" }, "externalServiceResultId": { "type": "string", "format": "uuid", "x-aura-field-code": "externalServiceResultId" }, "foreignAddress": { "type": "string", "x-aura-field-code": "foreignAddress" }, "neihgbourhood": { "type": "string", "x-aura-field-code": "neihgbourhood", "x-aura-maskable": true }, "neihgbourhoodCode": { "type": "string", "x-aura-field-code": "personNeihgbourhoodCode" }, "region": { "type": "string", "x-aura-field-code": "region" }, "regionCode": { "type": "string", "x-aura-field-code": "personAddressRegionCode" }, "section": { "type": "string", "x-aura-field-code": "section" }, "sectionCode": { "type": "string", "x-aura-field-code": "personAddressSectionCode" }, "street": { "type": "string", "x-aura-field-code": "street", "x-aura-maskable": true }, "streetCode": { "type": "string", "x-aura-field-code": "personAddressStreetCode" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "addressNumber": { "type": "string", "x-aura-field-code": "personAddressNumber", "x-aura-maskable": true }, "addressOpenText": { "type": "string", "x-aura-field-code": "addressOpenText", "x-aura-maskable": true }, "addressType": { "type": "integer", "format": "int32", "x-aura-field-code": "addressType" }, "birthDate": { "type": "string", "format": "date", "x-aura-field-code": "birthDate" }, "building": { "type": "string", "x-aura-field-code": "building", "x-aura-maskable": true }, "buildingCode": { "type": "string", "x-aura-field-code": "personAddressBuildingCode" }, "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "city": { "type": "string", "x-aura-field-code": "city", "x-aura-maskable": true }, "cityCode": { "type": "string", "x-aura-field-code": "personAddressCityCode" }, "correlationid": { "type": "string", "format": "uuid", "x-aura-field-code": "correlationid" }, "country": { "type": "string", "x-aura-field-code": "personAddressCountry" }, "countryId": { "type": "integer", "format": "int32", "x-aura-field-code": "countryId" }, "district": { "type": "string", "x-aura-field-code": "district", "x-aura-maskable": true }, "districtCode": { "type": "string", "x-aura-field-code": "personAddressDistrictCode" }, "externalServiceResultId": { "type": "string", "format": "uuid", "x-aura-field-code": "externalServiceResultId" }, "foreignAddress": { "type": "string", "x-aura-field-code": "foreignAddress" }, "neihgbourhood": { "type": "string", "x-aura-field-code": "neihgbourhood", "x-aura-maskable": true }, "neihgbourhoodCode": { "type": "string", "x-aura-field-code": "personNeihgbourhoodCode" }, "region": { "type": "string", "x-aura-field-code": "region" }, "regionCode": { "type": "string", "x-aura-field-code": "personAddressRegionCode" }, "section": { "type": "string", "x-aura-field-code": "section" }, "sectionCode": { "type": "string", "x-aura-field-code": "personAddressSectionCode" }, "street": { "type": "string", "x-aura-field-code": "street", "x-aura-maskable": true }, "streetCode": { "type": "string", "x-aura-field-code": "personAddressStreetCode" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-person-address-control-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "person-address-registrations", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/person-registrations": { "post": { "operationId": "aurax-bff-redirect-person-registration-control-bpm", "tags": [ "person-registrations" ], "summary": "aurax-bff-redirect-person-registration-control-bpm", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-person-registration-control-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "person-registrations", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/person-risk-levels": { "post": { "operationId": "aurax-bff-redirect-create-person-risk-level", "tags": [ "person-risk-levels" ], "summary": "aurax-bff-redirect-create-person-risk-level", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-person-risk-level", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "person-risk-levels", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/person-risk-levels/{id}": { "get": { "operationId": "aurax-bff-redirect-get-person-risk-level-by-id", "tags": [ "person-risk-levels" ], "summary": "aurax-bff-redirect-get-person-risk-level-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-person-risk-level-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "person-risk-levels/{id}", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/person-risk-levels/{id}/histories": { "get": { "operationId": "aurax-bff-redirect-get-person-risk-level-history-list", "tags": [ "person-risk-levels" ], "summary": "aurax-bff-redirect-get-person-risk-level-history-list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-person-risk-level-history-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "person-risk-levels/{id}/histories", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "post": { "operationId": "aurax-bff-redirect-create-person-risk-level-history", "tags": [ "person-risk-levels" ], "summary": "aurax-bff-redirect-create-person-risk-level-history", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-person-risk-level-history", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "person-risk-levels/{id}/histories", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/pool-definitions": { "get": { "operationId": "aurax-bff-redirect-get-pool-definition-list", "tags": [ "pool-definitions" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-pool-definition-list", "description": "Request and response fields are declared on the routing target `get-pool-definition-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "code" }, "currencies": { "type": "array", "items": { "type": "object", "x-aura-field-code": "currencies" } }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "poolDefinitionId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "name": { "type": "string", "x-aura-field-code": "name", "x-aura-maskable": true }, "poolType": { "type": "integer", "format": "int32", "x-aura-field-code": "poolType" }, "rates": { "type": "array", "items": { "type": "object", "x-aura-field-code": "rates" } }, "startDate": { "type": "string", "format": "date-time", "x-aura-field-code": "startDate" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-pool-definition-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "pool-definitions", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-pool-definition-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "List", "envelopes": [ "List" ], "payload": "PoolDefinitionDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "PoolType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "StartDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "EndDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "Rates", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." } } }, "/pool-definitions/{id}": { "get": { "operationId": "aurax-bff-redirect-get-pool-definition-by-id", "tags": [ "pool-definitions" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-pool-definition-by-id", "description": "Request and response fields are declared on the routing target `get-pool-definition-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "poolDefinitionId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "code" }, "currencies": { "type": "array", "items": { "type": "object", "x-aura-field-code": "currencies" } }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "poolDefinitionId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "name": { "type": "string", "x-aura-field-code": "name", "x-aura-maskable": true }, "poolType": { "type": "integer", "format": "int32", "x-aura-field-code": "poolType" }, "rates": { "type": "array", "items": { "type": "object", "x-aura-field-code": "rates" } }, "startDate": { "type": "string", "format": "date-time", "x-aura-field-code": "startDate" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-pool-definition-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "pool-definitions/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "PoolDefinitionDto", "payload": "PoolDefinitionDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "PoolType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "StartDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "EndDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "Rates", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_PRFTSHR_1", "status": 400, "message": null, "message_available": false, "constant_name": "POOL_DEFINITION_NOT_FOUND" } ] } } }, "/position-accounts": { "get": { "operationId": "aurax-bff-redirect-get-position-account-list", "tags": [ "position-accounts" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-position-account-list", "description": "Request and response fields are declared on the routing target `get-position-account-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "currencyGroup": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyGroup" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "currencyType": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyType" }, "foreignPositionLedgerCode": { "type": "string", "x-aura-field-code": "foreignPositionLedgerCode" }, "gainAccountLedgerCode": { "type": "string", "x-aura-field-code": "gainAccountLedgerCode" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "positionAccountId" }, "localPositionLedgerCode": { "type": "string", "x-aura-field-code": "localPositionLedgerCode" }, "lossAccountLedgerCode": { "type": "string", "x-aura-field-code": "lossAccountLedgerCode" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-position-account-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "position-accounts", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-position-account-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "PositionAccountDto", "collection": true, "members": [ { "name": "CurrencyType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CurrencyGroup", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ForeignPositionLedgerCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LocalPositionLedgerCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GainAccountLedgerCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LossAccountLedgerCode", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } }, "post": { "operationId": "aurax-bff-redirect-create-position-account-bpm", "tags": [ "position-accounts" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-create-position-account-bpm", "description": "Request and response fields are declared on the routing target `create-position-account-bpmn`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "currencyGroup": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyGroup" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "currencyType": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyType" }, "foreignPositionLedgerCode": { "type": "string", "x-aura-field-code": "foreignPositionLedgerCode" }, "gainAccountLedgerCode": { "type": "string", "x-aura-field-code": "gainAccountLedgerCode" }, "localPositionLedgerCode": { "type": "string", "x-aura-field-code": "localPositionLedgerCode" }, "lossAccountLedgerCode": { "type": "string", "x-aura-field-code": "lossAccountLedgerCode" } }, "required": [ "currencyGroup", "currencyNumber", "currencyType", "foreignPositionLedgerCode", "gainAccountLedgerCode", "localPositionLedgerCode", "lossAccountLedgerCode" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 7, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-position-account-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "position-accounts", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CurrencyType", "declared_type": null, "nullable": true, "collection": false }, { "name": "CurrencyGroup", "declared_type": null, "nullable": true, "collection": false }, { "name": "CurrencyNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "ForeignPositionLedgerCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "LocalPositionLedgerCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "GainAccountLedgerCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "LossAccountLedgerCode", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "put": { "operationId": "aurax-bff-redirect-update-position-account-bpmn", "tags": [ "position-accounts" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-update-position-account-bpmn", "description": "Request and response fields are declared on the routing target `update-position-account-bpmn`; this entry declares none of its own.\n\nDeclared as Route-bound but absent from the route template, so not sendable: id.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "currencyGroup": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyGroup" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "currencyType": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyType" }, "foreignPositionLedgerCode": { "type": "string", "x-aura-field-code": "foreignPositionLedgerCode" }, "gainAccountLedgerCode": { "type": "string", "x-aura-field-code": "gainAccountLedgerCode" }, "localPositionLedgerCode": { "type": "string", "x-aura-field-code": "localPositionLedgerCode" }, "lossAccountLedgerCode": { "type": "string", "x-aura-field-code": "lossAccountLedgerCode" } }, "required": [ "currencyGroup", "currencyNumber", "currencyType", "foreignPositionLedgerCode", "gainAccountLedgerCode", "localPositionLedgerCode", "lossAccountLedgerCode" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 7, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-position-account-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "position-accounts", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/position-accounts/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-position-account-bpmn", "tags": [ "position-accounts" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-delete-position-account-bpmn", "description": "Request and response fields are declared on the routing target `delete-position-account-bpmn`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "positionAccountId" } } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-position-account-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "position-accounts/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "get": { "operationId": "aurax-bff-redirect-get-position-account-by-id", "tags": [ "position-accounts" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-position-account-by-id", "description": "Request and response fields are declared on the routing target `get-position-account-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "positionAccountId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-position-account-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "position-accounts/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "PositionAccountDto", "payload": "PositionAccountDto", "collection": false, "members": [ { "name": "CurrencyType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CurrencyGroup", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ForeignPositionLedgerCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LocalPositionLedgerCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GainAccountLedgerCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LossAccountLedgerCode", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_244", "status": 400, "message": null, "message_available": false, "constant_name": "POSITION_ACCOUNT_NOT_FOUND" } ] } } }, "/process-definition-drafts": { "get": { "operationId": "aurax-bff-redirect-get-process-definition-draft-list", "tags": [ "process-definition-drafts" ], "summary": "aurax-bff-redirect-get-process-definition-draft-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-process-definition-draft-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "process-definition-drafts", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "ProcessDefinitionDraftDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "UserCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BpmnProcessId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "XmlResource", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-process-definition-draft-list", "target_dapr_app_id": "bpm-service", "target_route": "process-definition-drafts", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-process-definition-draft", "tags": [ "process-definition-drafts" ], "summary": "aurax-bff-redirect-create-process-definition-draft", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-process-definition-draft", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "process-definition-drafts", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "UserCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BpmnProcessId", "declared_type": null, "nullable": false, "collection": false }, { "name": "XmlResource", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "command-id", "note": "The route returns `AuraCommandDto`, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, `Id`, of type `Guid`. A caller gets a JSON OBJECT with one field, not a bare value. The field is `id` on the wire.", "declared_type": "AuraCommandDto", "envelopes": [ "AuraCommandDto" ], "payload": "Guid", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false, "wire_name": "id", "wire_name_basis": "framework-naming-policy" } ], "naming": "Member names are the service's declaration names.", "synthesized": true, "forwarded": { "service_code": "create-process-definition-draft", "target_dapr_app_id": "bpm-service", "target_route": "process-definition-drafts", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_BPM_35", "status": 400, "message": { "ar": "هناك بالفعل تعريف عملية مؤقتة بنفس المعرف للمستخدم.", "en": "There is already a temporary process definition with the same id for the user", "tr": "Bu kullanıcı için aynı bpmn id ile akış taslağı bulunmaktadır." }, "message_available": true, "constant_name": "PROCESS_DEFINITION_DRAFT_ALREADY_EXISTS" } ] } } }, "/process-definition-drafts/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-process-definition-draft", "tags": [ "process-definition-drafts" ], "summary": "aurax-bff-redirect-delete-process-definition-draft", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-process-definition-draft", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "process-definition-drafts/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "forwarded": { "service_code": "delete-process-definition-draft", "target_dapr_app_id": "bpm-service", "target_route": "process-definition-drafts/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_BPM_36", "status": 400, "message": { "ar": "لم يتم العثور على مسودة تعريف العملية.", "en": "Process Definition Draft cannot be found.", "tr": "Süreç Tanım Taslağı bulunamadı." }, "message_available": true, "constant_name": "PROCESS_DEFINITION_DRAFT_IS_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-process-definition-draft", "tags": [ "process-definition-drafts" ], "summary": "aurax-bff-redirect-update-process-definition-draft", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-process-definition-draft", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "process-definition-drafts/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "XmlResource", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "forwarded": { "service_code": "update-process-definition-draft", "target_dapr_app_id": "bpm-service", "target_route": "process-definition-drafts/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_BPM_36", "status": 400, "message": { "ar": "لم يتم العثور على مسودة تعريف العملية.", "en": "Process Definition Draft cannot be found.", "tr": "Süreç Tanım Taslağı bulunamadı." }, "message_available": true, "constant_name": "PROCESS_DEFINITION_DRAFT_IS_NOT_FOUND" } ] } } }, "/process-definitions": { "get": { "operationId": "aurax-bff-redirect-get-process-definition-list", "tags": [ "process-definitions" ], "summary": "aurax-bff-redirect-get-process-definition-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-process-definition-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "process-definitions", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "ProcessDefinitionDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "BpmnProcessId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ProcessDefinitionKey", "declared_type": "long?", "nullable": true, "collection": false }, { "name": "ResourceName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DeploymentTime", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "VersionNo", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "WaitForResponse", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "CanStarterUserApprove", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "CanPreviousUserApprove", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "UsageType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ProcessName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ProcessPriority", "declared_type": "int?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-process-definition-list", "target_dapr_app_id": "bpm-service", "target_route": "process-definitions", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-deploy-process-flow", "tags": [ "process-definitions" ], "summary": "aurax-bff-redirect-deploy-process-flow", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-deploy-process-flow", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "process-definitions", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "BpmnProcessId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/process-definitions/by-bpmn-process-id/{bpmnProcessId}": { "get": { "operationId": "aurax-bff-redirect-get-process-definition-by-bpmn-process-id", "tags": [ "process-definitions" ], "summary": "aurax-bff-redirect-get-process-definition-by-bpmn-process-id", "parameters": [ { "name": "bpmnProcessId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-process-definition-by-bpmn-process-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "process-definitions/by-bpmn-process-id/{bpmnProcessId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "BpmnProcessId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ProcessDefinitionExtendedDto", "payload": "ProcessDefinitionExtendedDto", "collection": false, "members": [ { "name": "XmlResource", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "BpmnProcessId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ProcessDefinitionKey", "declared_type": "long?", "nullable": true, "collection": false }, { "name": "ResourceName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DeploymentTime", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "VersionNo", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "WaitForResponse", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "CanStarterUserApprove", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "CanPreviousUserApprove", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "UsageType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ProcessName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ProcessPriority", "declared_type": "int?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-process-definition-by-bpmn-process-id", "target_dapr_app_id": "bpm-service", "target_route": "process-definitions/by-bpmn-process-id/{bpmnProcessId}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_BPM_21", "status": 400, "message": { "ar": "تعريف العملية غير موجود.", "en": "Process definition cannot be found.", "tr": "Süreç tanımı bulunamadı." }, "message_available": true, "constant_name": "PROCESS_DEFINITION_IS_NOT_FOUND" } ] } } }, "/process-definitions/{id}": { "get": { "operationId": "aurax-bff-redirect-get-process-definition-by-id", "tags": [ "process-definitions" ], "summary": "aurax-bff-redirect-get-process-definition-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-process-definition-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "process-definitions/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ProcessDefinitionByIdDto", "payload": "ProcessDefinitionByIdDto", "collection": false, "members": [ { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Path", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OperationType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "XmlResource", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "BpmnProcessId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ProcessDefinitionKey", "declared_type": "long?", "nullable": true, "collection": false }, { "name": "ResourceName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DeploymentTime", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "VersionNo", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "WaitForResponse", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "CanStarterUserApprove", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "CanPreviousUserApprove", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "UsageType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ProcessName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ProcessPriority", "declared_type": "int?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-process-definition-by-id", "target_dapr_app_id": "bpm-service", "target_route": "process-definitions/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_BPM_21", "status": 400, "message": { "ar": "تعريف العملية غير موجود.", "en": "Process definition cannot be found.", "tr": "Süreç tanımı bulunamadı." }, "message_available": true, "constant_name": "PROCESS_DEFINITION_IS_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-process-flow", "tags": [ "process-definitions" ], "summary": "aurax-bff-redirect-update-process-flow", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-process-flow", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "process-definitions/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/process-definitions/{id}/by-process-definition-key/{processDefinitionKey}/elements/{elementId}/user-tasks/first": { "get": { "operationId": "aurax-bff-get-user-task-process-element", "tags": [ "process-definitions" ], "summary": "aurax-bff-get-user-task-process-element", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "processDefinitionKey", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "elementId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-get-user-task-process-element", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "process-definitions/{id}/by-process-definition-key/{processDefinitionKey}/elements/{elementId}/user-tasks/first", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "ElementId", "declared_type": null, "nullable": false, "collection": false }, { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "ProcessDefinitionKey", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "UserTaskProcessElementDto", "payload": "UserTaskProcessElementDto", "collection": false, "members": [ { "name": "ProcessDefinitionId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ProcessElementId", "declared_type": "Guid", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/process-definitions/{id}/details": { "get": { "operationId": "aurax-bff-redirect-get-process-definition-detail-list", "tags": [ "process-definitions" ], "summary": "aurax-bff-redirect-get-process-definition-detail-list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-process-definition-detail-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "process-definitions/{id}/details", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "ProcessDefinitionDetailDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ProcessDefinitionKey", "declared_type": "long", "nullable": false, "collection": false }, { "name": "ResourceName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "XmlResource", "declared_type": "string", "nullable": false, "collection": false }, { "name": "VersionNo", "declared_type": "int", "nullable": false, "collection": false }, { "name": "DeploymentTime", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "UsageType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ProcessName", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-process-definition-detail-list", "target_dapr_app_id": "bpm-service", "target_route": "process-definitions/{id}/details", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/process-definitions/{id}/elements/user-tasks": { "get": { "operationId": "aurax-bff-get-process-definition-user-task-list", "tags": [ "process-definitions" ], "summary": "aurax-bff-get-process-definition-user-task-list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-get-process-definition-user-task-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "process-definitions/{id}/elements/user-tasks", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "PagedResultDto", "envelopes": [ "PagedResultDto" ], "payload": "ProcessElementDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ElementId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BpmnElementType", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/process-definitions/{id}/user-tasks": { "get": { "operationId": "aurax-bff-redirect-get-process-user-task-list", "tags": [ "process-definitions" ], "summary": "aurax-bff-redirect-get-process-user-task-list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-process-user-task-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "process-definitions/{id}/user-tasks", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "ProcessUserTaskDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ProcessDefinitionId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "OrganizationApprovementType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ElementId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ValidationSchema", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Translations", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-process-user-task-list", "target_dapr_app_id": "bpm-service", "target_route": "process-definitions/{id}/user-tasks", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_BPM_21", "status": 400, "message": { "ar": "تعريف العملية غير موجود.", "en": "Process definition cannot be found.", "tr": "Süreç tanımı bulunamadı." }, "message_available": true, "constant_name": "PROCESS_DEFINITION_IS_NOT_FOUND" } ] } }, "post": { "operationId": "aurax-bff-redirect-deploy-process-user-task", "tags": [ "process-definitions" ], "summary": "aurax-bff-redirect-deploy-process-user-task", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-deploy-process-user-task", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "process-definitions/{id}/user-tasks", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrganizationApprovementType", "declared_type": null, "nullable": false, "collection": false }, { "name": "ElementId", "declared_type": null, "nullable": false, "collection": false }, { "name": "ValidationSchema", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/process-definitions/{id}/user-tasks/{elementId}/actions-with-code": { "get": { "operationId": "aurax-bff-get-process-user-task-action-list", "tags": [ "process-definitions" ], "summary": "aurax-bff-get-process-user-task-action-list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "processDefinitionId" } }, { "name": "elementId", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "elementId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 2, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a collection.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-get-process-user-task-action-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "process-definitions/{id}/user-tasks/{elementId}/actions-with-code", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "ElementId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "ProcessUserTaskActionDto", "collection": true, "members": [ { "name": "ActionId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ActionCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ActionName", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/process-definitions/{id}/user-tasks/{processUserTaskId}": { "get": { "operationId": "aurax-bff-redirect-get-process-user-task-by-id", "tags": [ "process-definitions" ], "summary": "aurax-bff-redirect-get-process-user-task-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "processUserTaskId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-process-user-task-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "process-definitions/{id}/user-tasks/{processUserTaskId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "ProcessUserTaskId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ProcessUserTaskDto", "payload": "ProcessUserTaskDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ProcessDefinitionId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "OrganizationApprovementType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ElementId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ValidationSchema", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Translations", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-process-user-task-by-id", "target_dapr_app_id": "bpm-service", "target_route": "process-definitions/{id}/user-tasks/{processUserTaskId}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_BPM_21", "status": 400, "message": { "ar": "تعريف العملية غير موجود.", "en": "Process definition cannot be found.", "tr": "Süreç tanımı bulunamadı." }, "message_available": true, "constant_name": "PROCESS_DEFINITION_IS_NOT_FOUND" }, { "code": "ERR_BPM_57", "status": 400, "message": { "ar": "لم يتم العثور على معرف مهمة مستخدم العملية.", "en": "Process User Task Id not found.", "tr": "Process User Task Id bulunamadı." }, "message_available": true, "constant_name": "PROCESS_USER_TASK_NOT_EXISTS" } ] } } }, "/process-definitions/{id}/user-tasks/{processUserTaskId}/action-maps": { "get": { "operationId": "aurax-bff-redirect-get-process-user-task-action-map-list", "tags": [ "process-definitions" ], "summary": "aurax-bff-redirect-get-process-user-task-action-map-list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "processUserTaskId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-process-user-task-action-map-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "process-definitions/{id}/user-tasks/{processUserTaskId}/action-maps", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "ProcessUserTaskId", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "ProcessUserTaskActionMapDto", "collection": true, "members": [ { "name": "ProcessUserTaskId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ActionId", "declared_type": "Guid", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-process-user-task-action-map-list", "target_dapr_app_id": "bpm-service", "target_route": "process-definitions/{id}/user-tasks/{processUserTaskId}/action-maps", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_BPM_21", "status": 400, "message": { "ar": "تعريف العملية غير موجود.", "en": "Process definition cannot be found.", "tr": "Süreç tanımı bulunamadı." }, "message_available": true, "constant_name": "PROCESS_DEFINITION_IS_NOT_FOUND" }, { "code": "ERR_BPM_57", "status": 400, "message": { "ar": "لم يتم العثور على معرف مهمة مستخدم العملية.", "en": "Process User Task Id not found.", "tr": "Process User Task Id bulunamadı." }, "message_available": true, "constant_name": "PROCESS_USER_TASK_NOT_EXISTS" } ] } } }, "/process-definitions/{processDefinitionId}/user-tasks/{elementId}/authorized-actions": { "get": { "operationId": "aurax-bff-get-authorized-user-task-action-list", "tags": [ "process-definitions" ], "summary": "aurax-bff-get-authorized-user-task-action-list", "parameters": [ { "name": "processDefinitionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "processDefinitionId" } }, { "name": "elementId", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "elementId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 2, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-get-authorized-user-task-action-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "process-definitions/{processDefinitionId}/user-tasks/{elementId}/authorized-actions", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "ProcessDefinitionId", "declared_type": null, "nullable": false, "collection": false }, { "name": "ElementId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "AuthorizedUserTaskDto", "payload": "AuthorizedUserTaskDto", "collection": false, "members": [ { "name": "ValidationSchema", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Actions", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_AURAX_26", "status": 400, "message": null, "message_available": false, "constant_name": "NO_ACTIONS_IN_KYCL" } ] } } }, "/process-domain-inbox-event-list": { "post": { "operationId": "aurax-bff-redirect-process-domain-inbox-event-list", "tags": [ "process-domain-inbox-event-list" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-process-domain-inbox-event-list", "description": "Request and response fields are declared on the routing target `process-domain-inbox-event-list`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "daprAppId": { "type": "string", "x-aura-field-code": "daprAppId" }, "inboxEventIdList": { "type": "array", "items": { "type": "string", "format": "uuid", "x-aura-field-code": "inboxEventIdList" } } }, "required": [ "daprAppId", "inboxEventIdList" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 2, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-process-domain-inbox-event-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "process-domain-inbox-event-list", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/process-instances": { "get": { "operationId": "aurax-bff-redirect-get-bpm-process-instance-list", "tags": [ "process-instances" ], "summary": "aurax-bff-redirect-get-bpm-process-instance-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-bpm-process-instance-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "process-instances", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false }, { "name": "ProcessDefinitionId", "declared_type": null, "nullable": true, "collection": false }, { "name": "VersionNo", "declared_type": null, "nullable": true, "collection": false }, { "name": "ErrorMessage", "declared_type": null, "nullable": false, "collection": false }, { "name": "FieldCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "FieldValue", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsXmlIncluded", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "BpmProcessInstanceDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ProcessInstanceKey", "declared_type": "long", "nullable": false, "collection": false }, { "name": "BpmnProcessId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ProcessName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "VersionNo", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ProcessDefinitionKey", "declared_type": "long", "nullable": false, "collection": false }, { "name": "InstanceState", "declared_type": "string", "nullable": false, "collection": false }, { "name": "StartDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "EndDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "ProcessDefinitionId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ParentProcessInstanceKey", "declared_type": "long", "nullable": false, "collection": false }, { "name": "XmlResource", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UsageType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ProcessPriority", "declared_type": "int?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-bpm-process-instance-list", "target_dapr_app_id": "bpm-service", "target_route": "process-instances", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/process-instances/{id}": { "get": { "operationId": "aurax-bff-get-bpm-process-instance-by-id", "tags": [ "process-instances" ], "summary": "aurax-bff-get-bpm-process-instance-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-get-bpm-process-instance-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "process-instances/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "BpmProcessInstanceDto", "payload": "BpmProcessInstanceDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ProcessInstanceKey", "declared_type": "long", "nullable": false, "collection": false }, { "name": "BpmnProcessId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ProcessName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "VersionNo", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ProcessDefinitionKey", "declared_type": "long", "nullable": false, "collection": false }, { "name": "InstanceState", "declared_type": "string", "nullable": false, "collection": false }, { "name": "StartDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "EndDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "ProcessDefinitionId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ParentProcessInstanceKey", "declared_type": "long", "nullable": false, "collection": false }, { "name": "TraceId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "XmlResource", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/process-instances/{processInstanceKey}/element-instances": { "get": { "operationId": "aurax-bff-redirect-get-bpm-element-instance-list-by-process-instance-key", "tags": [ "process-instances" ], "summary": "aurax-bff-redirect-get-bpm-element-instance-list-by-process-instance-key", "parameters": [ { "name": "processInstanceKey", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-bpm-element-instance-list-by-process-instance-key", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "process-instances/{processInstanceKey}/element-instances", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false }, { "name": "ProcessInstanceKey", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "BpmElementInstanceDto", "collection": true, "members": [ { "name": "ElementInstanceKey", "declared_type": "long", "nullable": false, "collection": false }, { "name": "CreatedDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "ElementState", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FlowScopeKey", "declared_type": "long", "nullable": false, "collection": false }, { "name": "ElementId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BpmnElementType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "StartDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "EndDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "JobType", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-bpm-element-instance-list-by-process-instance-key", "target_dapr_app_id": "bpm-service", "target_route": "process-instances/{processInstanceKey}/element-instances", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/process-instances/{processInstanceKey}/errors": { "get": { "operationId": "aurax-bff-redirect-get-bpm-error-list-by-process-instance-key", "tags": [ "process-instances" ], "summary": "aurax-bff-redirect-get-bpm-error-list-by-process-instance-key", "parameters": [ { "name": "processInstanceKey", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-bpm-error-list-by-process-instance-key", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "process-instances/{processInstanceKey}/errors", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "ErrorEventPosition", "declared_type": null, "nullable": false, "collection": false }, { "name": "CreatedDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExceptionMessage", "declared_type": null, "nullable": false, "collection": false }, { "name": "StackTrace", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "BpmProcessErrorDto", "collection": true, "members": [ { "name": "ErrorEventPosition", "declared_type": "long", "nullable": false, "collection": false }, { "name": "CreatedDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "ExceptionMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "StackTrace", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-bpm-error-list-by-process-instance-key", "target_dapr_app_id": "bpm-service", "target_route": "process-instances/{processInstanceKey}/errors", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/process-instances/{processInstanceKey}/incidents": { "get": { "operationId": "aurax-bff-redirect-get-bpm-incident-list-by-process-instance-key", "tags": [ "process-instances" ], "summary": "aurax-bff-redirect-get-bpm-incident-list-by-process-instance-key", "parameters": [ { "name": "processInstanceKey", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-bpm-incident-list-by-process-instance-key", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "process-instances/{processInstanceKey}/incidents", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "BpmIncidentDto", "collection": true, "members": [ { "name": "IncidentKey", "declared_type": "long", "nullable": false, "collection": false }, { "name": "ErrorMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ErrorType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ElementInstanceKey", "declared_type": "long", "nullable": false, "collection": false }, { "name": "JobKey", "declared_type": "long", "nullable": false, "collection": false }, { "name": "CreatedDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "ResolvedDate", "declared_type": "DateTime?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-bpm-incident-list-by-process-instance-key", "target_dapr_app_id": "bpm-service", "target_route": "process-instances/{processInstanceKey}/incidents", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/process-instances/{processInstanceKey}/sub-processes": { "get": { "operationId": "aurax-bff-redirect-get-bpm-sub-process-list-by-process-instance-key", "tags": [ "process-instances" ], "summary": "aurax-bff-redirect-get-bpm-sub-process-list-by-process-instance-key", "parameters": [ { "name": "processInstanceKey", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-bpm-sub-process-list-by-process-instance-key", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "process-instances/{processInstanceKey}/sub-processes", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "BpmSubProcessDto", "collection": true, "members": [ { "name": "ElementId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ElementInstanceKey", "declared_type": "long", "nullable": false, "collection": false }, { "name": "CalledProcessInstanceKey", "declared_type": "long", "nullable": false, "collection": false }, { "name": "CalledBpmnProcessId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CalledProcessInstanceState", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ProcessDefinitionKey", "declared_type": "long", "nullable": false, "collection": false }, { "name": "ProcessId", "declared_type": "Guid", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-bpm-sub-process-list-by-process-instance-key", "target_dapr_app_id": "bpm-service", "target_route": "process-instances/{processInstanceKey}/sub-processes", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/process-instances/{processInstanceKey}/timers": { "get": { "operationId": "aurax-bff-redirect-get-bpm-timer-list-by-process-instance-key", "tags": [ "process-instances" ], "summary": "aurax-bff-redirect-get-bpm-timer-list-by-process-instance-key", "parameters": [ { "name": "processInstanceKey", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-bpm-timer-list-by-process-instance-key", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "process-instances/{processInstanceKey}/timers", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "TimerKey", "declared_type": null, "nullable": false, "collection": false }, { "name": "TimerState", "declared_type": null, "nullable": false, "collection": false }, { "name": "Repetitions", "declared_type": null, "nullable": false, "collection": false }, { "name": "CreatedDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "DueDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "ElementInstanceKey", "declared_type": null, "nullable": false, "collection": false }, { "name": "ElementId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "BpmTimerDto", "collection": true, "members": [ { "name": "TimerKey", "declared_type": "long", "nullable": false, "collection": false }, { "name": "TimerState", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Repetitions", "declared_type": "int", "nullable": false, "collection": false }, { "name": "CreatedDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "DueDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "ElementInstanceKey", "declared_type": "long", "nullable": false, "collection": false }, { "name": "ElementId", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-bpm-timer-list-by-process-instance-key", "target_dapr_app_id": "bpm-service", "target_route": "process-instances/{processInstanceKey}/timers", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/process-instances/{processInstanceKey}/variables": { "get": { "operationId": "aurax-bff-redirect-get-bpm-process-variable-list-by-process-instance-key", "tags": [ "process-instances" ], "summary": "aurax-bff-redirect-get-bpm-process-variable-list-by-process-instance-key", "parameters": [ { "name": "processInstanceKey", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-bpm-process-variable-list-by-process-instance-key", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "process-instances/{processInstanceKey}/variables", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false }, { "name": "ProcessInstanceKey", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "BpmProcessVariableDto", "collection": true, "members": [ { "name": "ElementId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ScopeKey", "declared_type": "long", "nullable": false, "collection": false }, { "name": "VariableState", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-bpm-process-variable-list-by-process-instance-key", "target_dapr_app_id": "bpm-service", "target_route": "process-instances/{processInstanceKey}/variables", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/product-categories": { "get": { "operationId": "aurax-bff-redirect-get-product-category-list", "tags": [ "product-categories" ], "summary": "aurax-bff-redirect-get-product-category-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-product-category-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "product-categories", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "ProductCategoryDto", "collection": true, "members": [ { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MaxInstallmentNumber", "declared_type": "int", "nullable": false, "collection": false }, { "name": "AlternativeInstallmentOption", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ParentProductCategoryId", "declared_type": "Guid?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-product-category-list", "target_dapr_app_id": "product-service", "target_route": "product-categories", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-product-category-ui-bpmn", "tags": [ "product-categories" ], "summary": "aurax-bff-redirect-create-product-category-ui-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-product-category-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "product-categories", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "Code", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "ParentProductCategoryId", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": null, "nullable": false, "collection": false }, { "name": "MaxInstallmentNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "AlternativeInstallmentOption", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/product-categories/{id}": { "get": { "operationId": "aurax-bff-redirect-get-product-categories-by-id", "tags": [ "product-categories" ], "summary": "aurax-bff-redirect-get-product-categories-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-product-categories-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "product-categories/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ProductCategoryDto", "payload": "ProductCategoryDto", "collection": false, "members": [ { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MaxInstallmentNumber", "declared_type": "int", "nullable": false, "collection": false }, { "name": "AlternativeInstallmentOption", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ParentProductCategoryId", "declared_type": "Guid?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-product-category-by-id", "target_dapr_app_id": "product-service", "target_route": "product-categories/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LPRDCT_43", "status": 400, "message": null, "message_available": false, "constant_name": "PRODUCT_CATEGORY_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-product-category-ui-bpmn", "tags": [ "product-categories" ], "summary": "aurax-bff-redirect-update-product-category-ui-bpmn", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-product-category-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "product-categories/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "Code", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "ParentProductCategoryId", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": null, "nullable": false, "collection": false }, { "name": "MaxInstallmentNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "AlternativeInstallmentOption", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/product-groups": { "get": { "operationId": "aurax-bff-redirect-get-product-group-list", "tags": [ "product-groups" ], "summary": "aurax-bff-redirect-get-product-group-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-product-group-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "product-groups", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Filter", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "LoanProductGroupDto", "collection": true, "members": [ { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ParentProductGroupId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "GroupType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-product-group-list", "target_dapr_app_id": "product-service", "target_route": "product-groups", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-loan-product-group-ui-bpmn", "tags": [ "product-groups" ], "summary": "aurax-bff-redirect-create-loan-product-group-ui-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-loan-product-group-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "product-groups", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Code", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/product-groups/{id}": { "get": { "operationId": "aurax-bff-redirect-get-product-group-by-id", "tags": [ "product-groups" ], "summary": "aurax-bff-redirect-get-product-group-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-product-group-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "product-groups/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "LoanProductGroupDto", "payload": "LoanProductGroupDto", "collection": false, "members": [ { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ParentProductGroupId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "GroupType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-product-group-by-id", "target_dapr_app_id": "product-service", "target_route": "product-groups/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LPRDCT_5", "status": 400, "message": { "ar": "لم يتم العثور على مجموعة المنتج. معرف مجموعة المنتج: {0}", "en": "ProductGroup is not found. ProductGroupId: {0}", "tr": "Ürün grubu bulunamadı. Ürün Grubu : {0}" }, "message_available": true, "constant_name": "PRODUCT_GROUP_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-loan-product-group-ui-bpmn", "tags": [ "product-groups" ], "summary": "aurax-bff-redirect-update-loan-product-group-ui-bpmn", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-loan-product-group-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "product-groups/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/product-groups/{loanId}/all-details": { "get": { "operationId": "aurax-bff-redirect-get-loan-product-group-ui-list", "tags": [ "product-groups" ], "summary": "aurax-bff-redirect-get-loan-product-group-ui-list", "parameters": [ { "name": "loanId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-loan-product-group-ui-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "product-groups/{loanId}/all-details", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/products": { "get": { "operationId": "aurax-bff-redirect-get-product-list", "tags": [ "products" ], "summary": "aurax-bff-redirect-get-product-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-product-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "products", "x-aura-request-contract": { "state": "route-claimed-by-two-repositories", "note": "Two services register this method and path, so this portal cannot say which one's request fields these would be. The fields a caller sends are exactly what would differ between them, so nothing is published rather than one of the two." }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "ProductDto", "collection": true, "members": [ { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ProductGroupId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "FundingSource", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ProposalValidityDay", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ProfitCalculationMethod", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "FinanceType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "DateDifference", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ProductStatus", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "AccountProductId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CashType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "RateTypes", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-product-list", "target_dapr_app_id": "product-service", "target_route": "products", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-loan-product-all-entity-ui-bpmn", "tags": [ "products" ], "summary": "aurax-bff-redirect-create-loan-product-all-entity-ui-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-loan-product-all-entity-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "products", "x-aura-request-contract": { "state": "route-claimed-by-two-repositories", "note": "Two services register this method and path, so this portal cannot say which one's request fields these would be. The fields a caller sends are exactly what would differ between them, so nothing is published rather than one of the two." }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/products-by-customer-cash-type": { "get": { "operationId": "aurax-bff-get-product-list-by-customer-and-cash-type", "tags": [ "products-by-customer-cash-type" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-get-product-list-by-customer-and-cash-type", "description": "Request and response fields are declared on the routing target `get-product-list-by-customer-and-cash-type`; this entry declares none of its own.", "parameters": [ { "name": "cashType", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "cashType" } }, { "name": "customerType", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "customerType" } }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 7 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "accountProductId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountProductId" }, "cashType": { "type": "integer", "format": "int32", "x-aura-field-code": "cashType" }, "code": { "type": "string", "x-aura-field-code": "loanProductCode" }, "customerType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerType" }, "dateDifference": { "type": "integer", "format": "int32", "x-aura-field-code": "dateDifference" }, "description": { "type": "string", "x-aura-field-code": "loanProductGroupDescription" }, "financeType": { "type": "integer", "format": "int32", "x-aura-field-code": "financeType" }, "fundingSource": { "type": "integer", "format": "int32", "x-aura-field-code": "fundingSource" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "loanProductId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "name": { "type": "string", "x-aura-field-code": "productName" }, "productGroupId": { "type": "string", "format": "uuid", "x-aura-field-code": "productGroupId" }, "productStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "productStatus" }, "profitCalculationMethod": { "type": "integer", "format": "int32", "x-aura-field-code": "profitCalculationMethod" }, "proposalValidityDay": { "type": "integer", "format": "int32", "x-aura-field-code": "proposalValidityDay" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-get-product-list-by-customer-and-cash-type", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "products-by-customer-cash-type", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "ProductByCustomerCashTypeDto", "collection": true, "members": [ { "name": "CustomerType", "declared_type": "int?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/products/{id}": { "get": { "operationId": "aurax-bff-redirect-get-product-by-id", "tags": [ "products" ], "summary": "aurax-bff-redirect-get-product-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-product-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "products/{id}", "x-aura-request-contract": { "state": "route-claimed-by-two-repositories", "note": "Two services register this method and path, so this portal cannot say which one's request fields these would be. The fields a caller sends are exactly what would differ between them, so nothing is published rather than one of the two." }, "x-aura-code-response": { "state": "structure", "declared_type": "ProductDto", "payload": "ProductDto", "collection": false, "members": [ { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ProductGroupId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "FundingSource", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ProposalValidityDay", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ProfitCalculationMethod", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "FinanceType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "DateDifference", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ProductStatus", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "AccountProductId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CashType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "RateTypes", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-product-by-id", "target_dapr_app_id": "product-service", "target_route": "products/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LPRDCT_10", "status": 400, "message": { "ar": "المنتج غير موجود. معرف المنتج: {0}", "en": "Product is not found. ProductId: {0}", "tr": "Ürün bulunamadı. Ürün Kodu: {0}" }, "message_available": true, "constant_name": "PRODUCT_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-loan-product-all-entity-ui-bpmn", "tags": [ "products" ], "summary": "aurax-bff-redirect-update-loan-product-all-entity-ui-bpmn", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-loan-product-all-entity-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "products/{id}", "x-aura-request-contract": { "state": "route-claimed-by-two-repositories", "note": "Two services register this method and path, so this portal cannot say which one's request fields these would be. The fields a caller sends are exactly what would differ between them, so nothing is published rather than one of the two." }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/products/{id}/currencies": { "get": { "operationId": "aurax-bff-redirect-get-product-currency-list", "tags": [ "products" ], "summary": "aurax-bff-redirect-get-product-currency-list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-product-currency-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "products/{id}/currencies", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "CurrencyDto", "collection": true, "members": [ { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-product-currency-list", "target_dapr_app_id": "product-service", "target_route": "products/{id}/currencies", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LPRDCT_10", "status": 400, "message": { "ar": "المنتج غير موجود. معرف المنتج: {0}", "en": "Product is not found. ProductId: {0}", "tr": "Ürün bulunamadı. Ürün Kodu: {0}" }, "message_available": true, "constant_name": "PRODUCT_NOT_FOUND" } ] } } }, "/products/{id}/customer-maps": { "get": { "operationId": "aurax-bff-redirect-get-product-customer-map-list", "tags": [ "products" ], "summary": "aurax-bff-redirect-get-product-customer-map-list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-product-customer-map-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "products/{id}/customer-maps", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "CustomerMapDto", "collection": true, "members": [ { "name": "CustomerType", "declared_type": "int", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-product-customer-map-list", "target_dapr_app_id": "product-service", "target_route": "products/{id}/customer-maps", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LPRDCT_10", "status": 400, "message": { "ar": "المنتج غير موجود. معرف المنتج: {0}", "en": "Product is not found. ProductId: {0}", "tr": "Ürün bulunamadı. Ürün Kodu: {0}" }, "message_available": true, "constant_name": "PRODUCT_NOT_FOUND" } ] } } }, "/products/{id}/details": { "get": { "operationId": "aurax-bff-redirect-get-product-details-by-id", "tags": [ "products" ], "summary": "aurax-bff-redirect-get-product-details-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-product-details-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "products/{id}/details", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ProductDetailsDto", "payload": "ProductDetailsDto", "collection": false, "members": [ { "name": "SpecialCondition", "declared_type": "SpecialConditionDto", "nullable": false, "collection": false }, { "name": "CustomerMaps", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Currencies", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Discounts", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Penalties", "declared_type": "List", "nullable": false, "collection": true }, { "name": "PaybackPlans", "declared_type": "List", "nullable": false, "collection": true }, { "name": "MaturityRateMatrix", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Taxes", "declared_type": "List", "nullable": false, "collection": true }, { "name": "ExpenseItems", "declared_type": "List", "nullable": false, "collection": true }, { "name": "ProductRisks", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Fields", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-product-details-by-id", "target_dapr_app_id": "product-service", "target_route": "products/{id}/details", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LPRDCT_10", "status": 400, "message": { "ar": "المنتج غير موجود. معرف المنتج: {0}", "en": "Product is not found. ProductId: {0}", "tr": "Ürün bulunamadı. Ürün Kodu: {0}" }, "message_available": true, "constant_name": "PRODUCT_NOT_FOUND" } ] } } }, "/products/{id}/fields": { "get": { "operationId": "aurax-bff-redirect-get-accrual-product-field-by-id", "tags": [ "products" ], "summary": "aurax-bff-redirect-get-accrual-product-field-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-accrual-product-field-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "products/{id}/fields", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "AccrualProductFieldDto", "collection": true, "members": [ { "name": "FieldId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "DataType", "declared_type": "int?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-accrual-product-field-by-id", "target_dapr_app_id": "accrual-service", "target_route": "products/{id}/fields", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCRL_2", "status": 400, "message": { "ar": "لم يتم العثور على المنتج بالمعرّف المقدم: '{0}'.", "en": "Product is cannot be found with the given: {0}.", "tr": "Verilen ürün bulunamadı: {0}." }, "message_available": true, "constant_name": "PRODUCT_IS_NOT_FOUND" } ] } } }, "/products/{id}/formulas": { "get": { "operationId": "aurax-bff-redirect-get-accrual-product-formula-by-id", "tags": [ "products" ], "summary": "aurax-bff-redirect-get-accrual-product-formula-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-accrual-product-formula-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "products/{id}/formulas", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "AccrualProductFormulaDto", "collection": true, "members": [ { "name": "AccrualProductFormulaId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FormulaDefinitionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "IsEarlyPaymentFormula", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "IsEarlyClosureFormula", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "IsPeriodicalCalculationFormula", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "IsDueCollectionFormula", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "HasEarlyOperations", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": "bool?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-accrual-product-formula-by-id", "target_dapr_app_id": "accrual-service", "target_route": "products/{id}/formulas", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCRL_2", "status": 400, "message": { "ar": "لم يتم العثور على المنتج بالمعرّف المقدم: '{0}'.", "en": "Product is cannot be found with the given: {0}.", "tr": "Verilen ürün bulunamadı: {0}." }, "message_available": true, "constant_name": "PRODUCT_IS_NOT_FOUND" } ] } } }, "/products/{id}/taxes": { "get": { "operationId": "aurax-bff-redirect-get-product-tax-list", "tags": [ "products" ], "summary": "aurax-bff-redirect-get-product-tax-list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-product-tax-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "products/{id}/taxes", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "TaxDto", "collection": true, "members": [ { "name": "TaxId", "declared_type": "Guid", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-product-tax-list", "target_dapr_app_id": "product-service", "target_route": "products/{id}/taxes", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LPRDCT_10", "status": 400, "message": { "ar": "المنتج غير موجود. معرف المنتج: {0}", "en": "Product is not found. ProductId: {0}", "tr": "Ürün bulunamadı. Ürün Kodu: {0}" }, "message_available": true, "constant_name": "PRODUCT_NOT_FOUND" } ] } } }, "/proposals": { "get": { "operationId": "aurax-bff-redirect-get-proposal-list", "tags": [ "proposals" ], "summary": "aurax-bff-redirect-get-proposal-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-proposal-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "proposals", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Filter", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "ProposalDto", "collection": true, "members": [ { "name": "ProposalNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerApplicationId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "LoanProductId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ProposalAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ProposalDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "ValidityDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "DateDifference", "declared_type": "int", "nullable": false, "collection": false }, { "name": "OrganizationId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-proposal-list", "target_dapr_app_id": "proposal-service", "target_route": "proposals", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-proposal-ui-bpmn", "tags": [ "proposals" ], "summary": "aurax-bff-redirect-create-proposal-ui-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-proposal-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "proposals", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CustomerApplicationId", "declared_type": null, "nullable": true, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "LoanProductId", "declared_type": null, "nullable": true, "collection": false }, { "name": "ProposalAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "CurrencyNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "ValidityDay", "declared_type": null, "nullable": true, "collection": false }, { "name": "DateDifference", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrganizationId", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/proposals/details": { "get": { "operationId": "aurax-bff-redirect-get-proposal-details-ui-list", "tags": [ "proposals" ], "summary": "aurax-bff-redirect-get-proposal-details-ui-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-proposal-details-ui-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "proposals/details", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/proposals/{id}": { "get": { "operationId": "aurax-bff-redirect-get-proposal-details-by-id", "tags": [ "proposals" ], "summary": "aurax-bff-redirect-get-proposal-details-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-proposal-details-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "proposals/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ProposalDetailsDto", "payload": "ProposalDetailsDto", "collection": false, "members": [ { "name": "Expenses", "declared_type": "List", "nullable": false, "collection": true }, { "name": "PaybackPlans", "declared_type": "List", "nullable": false, "collection": true }, { "name": "ProductDetails", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-proposal-details-by-id", "target_dapr_app_id": "proposal-service", "target_route": "proposals/{id}/details", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LPRPSL_4", "status": 400, "message": { "ar": "لا يمكن العثور على الاقتراح. : {0}", "en": "Proposal cannot be found. : {0}", "tr": "Teklif bulunamadı. : {0}" }, "message_available": true, "constant_name": "PROPOSAL_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-proposal-ui-bpmn", "tags": [ "proposals" ], "summary": "aurax-bff-redirect-update-proposal-ui-bpmn", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only", "x-aura-catalog-parameter-name": "proposalId" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-proposal-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "proposals/{proposalId}", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." }, "x-aura-path-template-merged": { "catalog_template": "/proposals/{proposalId}", "published_template": "/proposals/{id}", "renamed": { "proposalId": "id" }, "reason": "OpenAPI 3.1 §4.8.8 — paths differing only in template variable names are identical and MUST NOT coexist. A path parameter name is local to the template and positional on the wire, so this rename does not change the request; the catalog names are preserved on each parameter and here." } } }, "/provisions": { "get": { "operationId": "aurax-bff-redirect-get-provision-list", "tags": [ "provisions" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-provision-list", "description": "Request and response fields are declared on the routing target `get-provision-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "accountingEntryId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryId" }, "debtAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "debtAmount" }, "followTypeId": { "type": "string", "format": "uuid", "x-aura-field-code": "followTypeId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "provisionId" }, "provisionAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "provisionAmount" }, "provisionDate": { "type": "string", "format": "date", "x-aura-field-code": "provisionDate" }, "provisionType": { "type": "integer", "format": "int32", "x-aura-field-code": "provisionType" }, "reversedAccountingEntryId": { "type": "string", "format": "uuid", "x-aura-field-code": "reversedAccountingEntryId" }, "reversedDate": { "type": "string", "format": "date", "x-aura-field-code": "reversedDate" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "status" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-provision-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "provisions", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-provision-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "ProvisionDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ProvisionType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "FollowTypeId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "DebtAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "ProvisionAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "AccountingEntryId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ReversedAccountingEntryId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ReversedDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "Status", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ProvisionDate", "declared_type": "DateOnly?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/provisions/{provisionId}": { "get": { "operationId": "aurax-bff-redirect-get-provision-item-list-by-provision-id", "tags": [ "provisions" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-provision-item-list-by-provision-id", "description": "Request and response fields are declared on the routing target `get-provision-item-list-by-provision-id`; this entry declares none of its own.", "parameters": [ { "name": "provisionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "provisionId" } }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "customerFollowDebtId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerFollowDebtId" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "debtAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "debtAmount" }, "delayDayCount": { "type": "integer", "format": "int32", "x-aura-field-code": "delayDayCount" }, "id": { "x-aura-type": "unresolved" }, "loanId": { "type": "string", "format": "uuid", "x-aura-field-code": "loanId" }, "provisionAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "provisionAmount" }, "provisionId": { "type": "string", "format": "uuid", "x-aura-field-code": "provisionId" }, "provisionItemDetails": { "type": "array", "items": { "type": "object", "properties": { "debtAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "debtAmount" }, "debtItem": { "type": "integer", "format": "int32", "x-aura-field-code": "debtItem" }, "followTypeProvisionId": { "type": "string", "format": "uuid", "x-aura-field-code": "followTypeProvisionId" }, "id": { "x-aura-type": "unresolved" }, "provisionAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "provisionAmount" } }, "x-aura-field-code": "provisionItemDetails" } }, "provisionRate": { "type": "number", "format": "decimal", "x-aura-field-code": "provisionRate" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-provision-item-list-by-provision-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "provisions/{provisionId}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-provision-item-list-by-provision-id`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "ProvisionItemDto", "collection": true, "members": [ { "name": "LoanId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ProvisionId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerFollowDebtId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "DelayDayCount", "declared_type": "int", "nullable": false, "collection": false }, { "name": "DebtAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "ProvisionAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "ProvisionRate", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "ProvisionItemDetails", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." } } }, "/pwf-change-user-password": { "post": { "operationId": "aurax-bff-redirect-pwf-change-user-password-bpm", "tags": [ "pwf-change-user-password" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-pwf-change-user-password-bpm", "description": "Read from the caller's token, not from the request: username.", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 1, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-pwf-change-user-password-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "pwf-change-user-password", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/pwf-create-document": { "post": { "operationId": "aurax-bff-redirect-pwf-create-document", "tags": [ "pwf-create-document" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-pwf-create-document", "description": "Request and response fields are declared on the routing target `pwf-create-document`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "applicationName": { "type": "string", "x-aura-field-code": "applicationName" }, "customerId": { "type": "integer", "format": "int32", "x-aura-field-code": "pwfCustomerId" }, "ownerKey": { "type": "string", "x-aura-field-code": "ownerKey" }, "referenceToken": { "type": "string", "x-aura-field-code": "referenceToken" }, "templateDesignId": { "type": "string", "format": "uuid", "x-aura-field-code": "templateDesignId" } }, "required": [ "applicationName", "customerId", "ownerKey", "referenceToken", "templateDesignId" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 5, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "status": { "type": "integer", "format": "int32", "x-aura-field-code": "status" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "status": { "type": "integer", "format": "int32", "x-aura-field-code": "status" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "status": { "type": "integer", "format": "int32", "x-aura-field-code": "status" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-pwf-create-document", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "pwf-create-document", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/pwf-verify-and-login": { "post": { "operationId": "aurax-bff-redirect-pwf-login", "tags": [ "pwf-verify-and-login" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-pwf-login", "description": "Invokes the `aurax-bff-redirect-pwf-login` service definition through `POST /pwf-verify-and-login`.\n\nRequest and response fields are declared on the routing target `pwf-login`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "applicationNames": { "type": "array", "items": { "type": "string", "x-aura-field-code": "applicationNames" } }, "citizienId": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "loginOtp": { "type": "string", "x-aura-field-code": "loginOtp" }, "password": { "type": "string", "x-aura-field-code": "keycloak_password", "x-aura-encrypted": true } }, "required": [ "applicationNames", "citizienId", "password" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 4, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "token": { "type": "string", "x-aura-field-code": "token" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "token": { "type": "string", "x-aura-field-code": "token" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "token": { "type": "string", "x-aura-field-code": "token" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-pwf-login", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "pwf-verify-and-login", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/queries": { "get": { "operationId": "aurax-bff-redirect-get-query-definition-list", "tags": [ "queries" ], "summary": "aurax-bff-redirect-get-query-definition-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-query-definition-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "queries", "x-aura-request-contract": { "state": "route-claimed-by-two-repositories", "note": "Two services register this method and path, so this portal cannot say which one's request fields these would be. The fields a caller sends are exactly what would differ between them, so nothing is published rather than one of the two." }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "QueryDefinitionDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "QueryScripts", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-query-definition-list", "target_dapr_app_id": "core-service", "target_route": "queries", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/redirect/loans/invoices": { "get": { "operationId": "aurax-bff-redirect-get-loan-invoice-list", "tags": [ "redirect" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-loan-invoice-list", "description": "Request and response fields are declared on the routing target `get-loan-invoice-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a collection.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-loan-invoice-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "redirect/loans/invoices", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-loan-invoice-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "LoanInvoiceDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "LoanId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "InvoiceAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "InvoiceDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "SerialNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UsingInvoiceAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "ShipmentDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "InvoiceIssuer", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsOfficialInvoice", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/redirect/loans/{id}/invoices/{invoiceId}": { "delete": { "operationId": "aurax-bff-redirect-delete-loan-invoice", "tags": [ "redirect" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-delete-loan-invoice", "description": "Request and response fields are declared on the routing target `delete-loan-invoice`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "loanId" } }, { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "invoiceId" } } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 2, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-loan-invoice", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "redirect/loans/{id}/invoices/{invoiceId}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LOAN_107", "status": 400, "message": { "ar": "يجب أن يكون تاريخ القرض اليوم للإلغاء", "en": "Loan Date Must Be Today For Cancel" }, "message_available": true, "constant_name": "LOAN_INVOICE_NOT_FOUND" }, { "code": "ERR_LOAN_17", "status": 400, "message": null, "message_available": false, "constant_name": "LOAN_MUST_NOT_BE_NULL" } ] } } }, "/requirement-configs": { "get": { "operationId": "aurax-bff-get-requirement-config-list", "tags": [ "requirement-configs" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-get-requirement-config-list", "description": "Request and response fields are declared on the routing target `get-requirement-config-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "requirementConfigCode" }, "configType": { "type": "integer", "format": "int32", "x-aura-field-code": "configType" }, "configValue": { "type": "string", "x-aura-field-code": "configValue" }, "description": { "type": "string", "x-aura-field-code": "requirementConfigDescription" }, "id": { "type": "string", "x-aura-field-code": "requirementConfigId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-get-requirement-config-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "requirement-configs", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-requirement-config-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "RequirementConfigDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ConfigType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ConfigValue", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/requirement-configs/by-code/{code}": { "get": { "operationId": "aurax-bff-get-requirement-config-by-code", "tags": [ "requirement-configs" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-get-requirement-config-by-code", "description": "Request and response fields are declared on the routing target `get-requirement-config-by-code`; this entry declares none of its own.", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "requirementConfigCode" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "requirementConfigCode" }, "configType": { "type": "integer", "format": "int32", "x-aura-field-code": "configType" }, "configValue": { "type": "string", "x-aura-field-code": "configValue" }, "description": { "type": "string", "x-aura-field-code": "requirementConfigDescription" }, "id": { "type": "string", "x-aura-field-code": "requirementConfigId" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-get-requirement-config-by-code", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "requirement-configs/by-code/{code}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Code", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "RequirementConfigDto", "payload": "RequirementConfigDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ConfigType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ConfigValue", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ALLTMNT_79", "status": 400, "message": null, "message_available": false, "constant_name": "REQUIREMENT_CONFIG_NOT_FOUND" } ] } } }, "/requirement-configs/{id}": { "get": { "operationId": "aurax-bff-get-requirement-config-by-id", "tags": [ "requirement-configs" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-get-requirement-config-by-id", "description": "Request and response fields are declared on the routing target `get-requirement-config-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "requirementConfigId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "requirementConfigCode" }, "configType": { "type": "integer", "format": "int32", "x-aura-field-code": "configType" }, "configValue": { "type": "string", "x-aura-field-code": "configValue" }, "description": { "type": "string", "x-aura-field-code": "requirementConfigDescription" }, "id": { "type": "string", "x-aura-field-code": "requirementConfigId" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-get-requirement-config-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "requirement-configs/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "RequirementConfigDto", "payload": "RequirementConfigDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ConfigType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ConfigValue", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ALLTMNT_79", "status": 400, "message": null, "message_available": false, "constant_name": "REQUIREMENT_CONFIG_NOT_FOUND" } ] } } }, "/reserved-customers": { "get": { "operationId": "aurax-bff-dynamic-get-customer-reserved-list", "tags": [ "reserved-customers" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-customer-reserved-list", "description": "Request and response fields are declared on the routing target `get-customer-reserved-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 3 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "customerNumber": { "type": "string", "x-aura-field-code": "customerNumber" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerReservedId" }, "isReserved": { "type": "boolean", "x-aura-field-code": "isReserved" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-customer-reserved-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "reserved-customers", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-customer-reserved-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "post": { "operationId": "aurax-bff-dynamic-create-customer-reserved-bpm", "tags": [ "reserved-customers" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "Create Customer Number Reserved", "description": "Invokes the `aurax-bff-dynamic-create-customer-reserved-bpm` service definition through `POST /reserved-customers`.\n\nRequest and response fields are declared on the routing target `create-customer-reserved-bpm`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "reservedCustomerNumbers": { "type": "array", "items": { "type": "object", "properties": { "customerNumber": { "type": "string", "x-aura-field-code": "customerNumber" } }, "required": [ "customerNumber" ], "x-aura-field-code": "reservedCustomerNumbers" } } }, "required": [ "reservedCustomerNumbers" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "reservedCustomerNumbers": { "type": "array", "items": { "type": "object", "x-aura-field-code": "reservedCustomerNumbers" } } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "reservedCustomerNumbers": { "type": "array", "items": { "type": "object", "x-aura-field-code": "reservedCustomerNumbers" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "reservedCustomerNumbers": { "type": "array", "items": { "type": "object", "x-aura-field-code": "reservedCustomerNumbers" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-create-customer-reserved-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "reserved-customers", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/reserved-customers/{id}": { "delete": { "operationId": "aurax-bff-dynamic-delete-customer-reserved-bpm", "tags": [ "reserved-customers" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "Delete Customer Number Reserved", "description": "Invokes the `aurax-bff-dynamic-delete-customer-reserved-bpm` service definition through `DELETE /reserved-customers/{id}`.\n\nRequest and response fields are declared on the routing target `delete-customer-reserved-bpm`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in this route template but not among the Route-bound fields of the routing target `delete-customer-reserved-bpm`, whose own path is decoupled from this one.", "x-aura-source": "route-template-only-after-collapse" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerReservedId" } }, "required": [ "id" ] } } }, "description": "The catalog declares Body-bound fields on this DELETE operation. Request bodies on DELETE have no defined semantics in HTTP; this documents the catalog, not a recommendation. Not every field below is accepted: the platform selects which of them this operation admits and drops the rest. Of the fields below, the binder does not admit `id`, which this document nevertheless marks required because the catalog declares it so.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [ "body" ], "dropped_field_names": { "body": [ "id" ] }, "dropped_mandatory_field_names": [ "id" ], "verdict": "declared-fields-not-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": "The HTTP edge in front of this operation comes in two shapes and they differ: the platform's typed route readers bind GET and DELETE from the URL and never read a body, while its untyped catalog-redirect reader collects the body whenever the request carries one. It does not change the answer above: the selection below happens after the edge, and excludes these fields either way." }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-delete-customer-reserved-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "reserved-customers/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/risk-definitions": { "get": { "operationId": "aurax-bff-redirect-get-risk-definition-list", "tags": [ "risk-definitions" ], "summary": "aurax-bff-redirect-get-risk-definition-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-risk-definition-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "risk-definitions", "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "RiskDefinitionDto", "collection": true, "members": [ { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "CustomerType", "declared_type": "int", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-risk-definition-list", "target_dapr_app_id": "risk-management-service", "target_route": "risks", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/risk-ledgers": { "get": { "operationId": "aurax-bff-redirect-get-risk-ledger-list", "tags": [ "risk-ledgers" ], "summary": "aurax-bff-redirect-get-risk-ledger-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-risk-ledger-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "risk-ledgers", "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "RiskLedgerBaseDto", "collection": true, "members": [ { "name": "CurrencyRateType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "LedgerCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AccountProductId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Rate", "declared_type": "decimal?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-risk-ledger-list", "target_dapr_app_id": "risk-management-service", "target_route": "risks/{id}/ledgers", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/risks": { "post": { "operationId": "aurax-bff-redirect-create-risk-definition-ui-bpm", "tags": [ "risks" ], "summary": "aurax-bff-redirect-create-risk-definition-ui-bpm", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-risk-definition-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "risks", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Code", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerType", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/risks/{id}": { "put": { "operationId": "aurax-bff-redirect-edit-risk-definition-ui-bpm", "tags": [ "risks" ], "summary": "aurax-bff-redirect-edit-risk-definition-ui-bpm", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-edit-risk-definition-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "risks/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerType", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/risks/{id}/details": { "get": { "operationId": "aurax-bff-redirect-get-risk-definition-details-by-id", "tags": [ "risks" ], "summary": "aurax-bff-redirect-get-risk-definition-details-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-risk-definition-details-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "risks/{id}/details", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "RiskDefinitionDetailDto", "payload": "RiskDefinitionDetailDto", "collection": false, "members": [ { "name": "QueryPurposes", "declared_type": "List", "nullable": false, "collection": true }, { "name": "RiskLedgers", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-risk-definition-details-by-id", "target_dapr_app_id": "risk-management-service", "target_route": "risks/{id}/details", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_RISKMNG_2", "status": 400, "message": { "ar": "تعذر العثور على تعريف المخاطر. :{0}", "en": "Risk definition cannot be found. :{0}", "tr": "Risk tanımı bulunamadı. : {0}" }, "message_available": true, "constant_name": "RISK_DEFINITION_MUST_BE_NOT_NULL" } ] } } }, "/roles": { "get": { "operationId": "aurax-bff-redirect-get-realm-role-list", "tags": [ "roles" ], "summary": "aurax-bff-redirect-get-realm-role-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-realm-role-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "roles", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "post": { "operationId": "aurax-bff-redirect-create-realm-role-bpm", "tags": [ "roles" ], "summary": "aurax-bff-redirect-create-realm-role-bpm", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-realm-role-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "roles", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/roles/{roleId}": { "delete": { "operationId": "aurax-bff-redirect-delete-realm-role-bpm", "tags": [ "roles" ], "summary": "aurax-bff-redirect-delete-realm-role-bpm", "parameters": [ { "name": "roleId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-realm-role-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "roles/{roleId}", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "get": { "operationId": "aurax-bff-redirect-get-realm-role-by-id", "tags": [ "roles" ], "summary": "aurax-bff-redirect-get-realm-role-by-id", "parameters": [ { "name": "roleId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-realm-role-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "roles/{roleId}", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "put": { "operationId": "aurax-bff-redirect-update-realm-role-bpm", "tags": [ "roles" ], "summary": "aurax-bff-redirect-update-realm-role-bpm", "parameters": [ { "name": "roleId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-realm-role-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "roles/{roleId}", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/roles/{roleId}/associate/realm": { "get": { "operationId": "aurax-bff-get-composite-role-list", "tags": [ "roles" ], "summary": "aurax-bff-get-composite-role-list", "parameters": [ { "name": "roleId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-get-composite-role-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "roles/{roleId}/associate/realm", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "RoleId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "PagedResultDto", "envelopes": [ "PagedResultDto" ], "payload": "GetCompositeRoleListDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Composite", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "ClientRole", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "ContainerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Inherited", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } }, "post": { "operationId": "aurax-bff-redirect-associate-realm-role-bpm", "tags": [ "roles" ], "summary": "aurax-bff-redirect-associate-realm-role-bpm", "parameters": [ { "name": "roleId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-associate-realm-role-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "roles/{roleId}/associate/realm", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/roles/{roleId}/{roleName}/users": { "get": { "operationId": "aurax-bff-redirect-get-users-in-role", "tags": [ "roles" ], "summary": "aurax-bff-redirect-get-users-in-role", "parameters": [ { "name": "roleId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "roleName", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-users-in-role", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "roles/{roleId}/{roleName}/users", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/save-and-read-prepaid-transactions-scheduler-bpmn": { "post": { "operationId": "aurax-bff-redirect-save-and-read-prepaid-transactions-scheduler-bpmn", "tags": [ "save-and-read-prepaid-transactions-scheduler-bpmn" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-save-and-read-prepaid-transactions-scheduler-bpmn", "description": "Request and response fields are declared on the routing target `save-and-read-prepaid-transactions-scheduler-bpmn`; this entry declares none of its own.", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-save-and-read-prepaid-transactions-scheduler-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "save-and-read-prepaid-transactions-scheduler-bpmn", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/saved-transactions": { "get": { "operationId": "aurax-bff-redirect-get-saved-transaction-list", "tags": [ "saved-transactions" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-saved-transaction-list", "description": "Request and response fields are declared on the routing target `get-saved-transaction-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "search" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 6 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a collection.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-saved-transaction-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "saved-transactions", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-saved-transaction-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false }, { "name": "Search", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "SavedTransactionDto", "collection": true, "members": [ { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MaskedName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransactionType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "FromCustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "FromAccountId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ToCustomerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ToAccountId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ToIban", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MaskedToIban", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ToOwner", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MaskedToOwner", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Amount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "PaymentPurpose", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BankCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BankName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FromEasyAddress", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "EasyAddressType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "EasyAddressTypeValue", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/saved-transactions/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-saved-transaction-bpm", "tags": [ "saved-transactions" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-delete-saved-transaction-bpm", "description": "Request and response fields are declared on the routing target `delete-saved-transaction-bpm`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "savedTransactionId" } } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-saved-transaction-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "saved-transactions/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/send-bulk-sms-bpm": { "post": { "operationId": "aurax-bff-redirect-send-bulk-sms-bpm", "tags": [ "send-bulk-sms-bpm" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-send-bulk-sms-bpm", "description": "Request and response fields are declared on the routing target `send-bulk-sms-bpm`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "messageText": { "type": "string", "x-aura-field-code": "messageText" }, "phoneList": { "type": "array", "items": { "type": "object", "x-aura-field-code": "phoneList" } }, "subject": { "type": "string", "x-aura-field-code": "subject" } }, "required": [ "messageText", "phoneList", "subject" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 3, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-send-bulk-sms-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "send-bulk-sms-bpm", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/send-otp-for-login": { "post": { "operationId": "send-otp-to-authenticate-user", "tags": [ "send-otp-for-login" ], "summary": "send-otp-to-authenticate-user", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "otpName": { "type": "string", "x-aura-field-code": "otpName" }, "password": { "type": "string", "x-aura-field-code": "keycloak_password", "x-aura-encrypted": true }, "userName": { "type": "string", "x-aura-field-code": "userName" } }, "required": [ "password", "userName" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 3, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "send-otp-to-authenticate-user", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "send-otp-for-login", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "UserName", "declared_type": null, "nullable": false, "collection": false }, { "name": "Password", "declared_type": null, "nullable": false, "collection": false }, { "name": "OtpName", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "SendOtpToAuthenticateUserResponse", "payload": "SendOtpToAuthenticateUserResponse", "collection": false, "members": [ { "name": "TransactionId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "EndDate", "declared_type": "DateTime", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/send-otp-for-reset": { "post": { "operationId": "send-otp-for-reset-password", "tags": [ "send-otp-for-reset" ], "summary": "send-otp-for-reset-password", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "newPassword": { "type": "string", "x-aura-field-code": "newPassword", "x-aura-encrypted": true }, "oldPassword": { "type": "string", "x-aura-field-code": "oldPassword", "x-aura-encrypted": true }, "otpName": { "type": "string", "x-aura-field-code": "otpName" }, "userName": { "type": "string", "x-aura-field-code": "userName" } }, "required": [ "newPassword", "oldPassword", "userName" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 4, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "send-otp-for-reset-password", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "send-otp-for-reset", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "UserName", "declared_type": null, "nullable": false, "collection": false }, { "name": "OldPassword", "declared_type": null, "nullable": false, "collection": false }, { "name": "NewPassword", "declared_type": null, "nullable": false, "collection": false }, { "name": "OtpName", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "SendOtpToAuthenticateUserResponse", "payload": "SendOtpToAuthenticateUserResponse", "collection": false, "members": [ { "name": "TransactionId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "EndDate", "declared_type": "DateTime", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/send-sms-otp": { "post": { "operationId": "aurax-bff-redirect-send-sms-otp", "tags": [ "send-sms-otp" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-send-sms-otp", "description": "Request and response fields are declared on the routing target `send-sms-otp`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "otpName": { "type": "string", "x-aura-field-code": "otpName" }, "phoneNumber": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true } }, "required": [ "otpName", "phoneNumber" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 2, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-send-sms-otp", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "send-sms-otp", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "structure", "declared_type": "SendSmsOtpDto", "payload": "SendSmsOtpDto", "collection": false, "members": [ { "name": "TransactionId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "EndDate", "declared_type": "DateTime?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/service-logs": { "get": { "operationId": "aurax-bff-redirect-get-service-log-list", "tags": [ "service-logs" ], "summary": "aurax-bff-redirect-get-service-log-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-service-log-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "service-logs", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "ServiceLogDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "DomainDefinitionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ServiceDefinitionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "UserCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ClientId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ProcessDefinitionKey", "declared_type": "long?", "nullable": true, "collection": false }, { "name": "CorrelationId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ExecutionTime", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "ExecutionDuration", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ClientIp", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BrowserInfo", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OperationType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Url", "declared_type": "string", "nullable": false, "collection": false }, { "name": "HttpStatusCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ExceptionMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FormDefinitionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ChannelId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ResourceCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PartnerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "FormExecutedAction", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsInternalIpSource", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "UserTitleRole", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UserType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FormVisibleAction", "declared_type": "IEnumerable", "nullable": false, "collection": true }, { "name": "GroupMembership", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-service-log-list", "target_dapr_app_id": "audit-service", "target_route": "service-logs", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/service-logs/{id}/details": { "get": { "operationId": "aurax-bff-redirect-get-service-log-detail-by-id", "tags": [ "service-logs" ], "summary": "aurax-bff-redirect-get-service-log-detail-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-service-log-detail-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "service-logs/{id}/details", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ServiceLogDetailDto", "payload": "ServiceLogDetailDto", "collection": false, "members": [ { "name": "DomainDefinitionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ServiceDefinitionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "UserCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ClientId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ProcessDefinitionKey", "declared_type": "long?", "nullable": true, "collection": false }, { "name": "CorrelationId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ExecutionTime", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "ExecutionDuration", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ClientIp", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BrowserInfo", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OperationType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Url", "declared_type": "string", "nullable": false, "collection": false }, { "name": "HttpStatusCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ExceptionMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FormDefinitionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ChannelId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ResourceCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PartnerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "FormExecutedAction", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsInternalIpSource", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "UserTitleRole", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UserType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Request", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Response", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FormVisibleAction", "declared_type": "IEnumerable", "nullable": false, "collection": true }, { "name": "GroupMembership", "declared_type": "IEnumerable", "nullable": false, "collection": true }, { "name": "EntityLogs", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-service-log-detail-by-id", "target_dapr_app_id": "audit-service", "target_route": "service-logs/{id}/details", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/services": { "get": { "operationId": "aurax-bff-redirect-get-service-definition-list", "tags": [ "services" ], "summary": "aurax-bff-redirect-get-service-definition-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-service-definition-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "services", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "ServiceDefinitionDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "HasFilter", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "HasSharedCacheData", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "HasPaging", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "DefaultPagingSize", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "HasOrder", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "DefaultOrderField", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DefaultOrderType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsCacheable", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "CacheDuration", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "Path", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DomainId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "OperationType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Type", "declared_type": "int", "nullable": false, "collection": false }, { "name": "UsageType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Weight", "declared_type": "double?", "nullable": true, "collection": false }, { "name": "BusinessWeight", "declared_type": "double?", "nullable": true, "collection": false }, { "name": "HasBpmVariable", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "ResponseFieldDefinitionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "RequestFieldId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "IsTransactional", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "IsRedirect", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "RoutingServiceDefinitionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "FraudServiceDefinitionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "TimeoutDuration", "declared_type": "long?", "nullable": true, "collection": false }, { "name": "IsLogDetailEnabled", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "HasTranslationData", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "RollbackServiceDefinitionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "RollbackEventDefinitionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "KeywordIdList", "declared_type": "IEnumerable", "nullable": false, "collection": true }, { "name": "Translations", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-service-definition-list", "target_dapr_app_id": "core-service", "target_route": "services", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-service-definition", "tags": [ "services" ], "summary": "aurax-bff-redirect-create-service-definition", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-service-definition", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "services", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Code", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/services-bpmn": { "post": { "operationId": "aurax-bff-redirect-define-new-service-flow-bpmn", "tags": [ "services-bpmn" ], "summary": "aurax-bff-redirect-define-new-service-flow-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-define-new-service-flow-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "services-bpmn", "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/services-bpmn/{code}": { "get": { "operationId": "aurax-bff-redirect-get-service-by-code", "tags": [ "services-bpmn" ], "summary": "aurax-bff-redirect-get-service-by-code", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-service-by-code", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "services-bpmn/{code}", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/services-bpmn/{code}/{id}": { "get": { "operationId": "aurax-bff-get-service-detail-list", "tags": [ "services-bpmn" ], "summary": "aurax-bff-get-service-detail-list", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-get-service-detail-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "services-bpmn/{code}/{id}", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "put": { "operationId": "aurax-bff-redirect-update-service-bpm", "tags": [ "services-bpmn" ], "summary": "aurax-bff-redirect-update-service-bpm", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-service-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "services-bpmn/{code}/{id}", "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/services/by-code/{code}/details": { "get": { "operationId": "aurax-bff-redirect-get-service-detail-by-code", "tags": [ "services" ], "summary": "aurax-bff-redirect-get-service-detail-by-code", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-service-detail-by-code", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "services/by-code/{code}/details", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Code", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/services/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-service-definition", "tags": [ "services" ], "summary": "aurax-bff-redirect-delete-service-definition", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-service-definition", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "services/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "forwarded": { "service_code": "delete-service-definition", "target_dapr_app_id": "core-service", "target_route": "services/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_CORE_40", "status": 400, "message": { "ar": "لم يتم العثور على معرف الخدمة.", "en": "Service cannot be found.", "tr": "Servis bulunamadı." }, "message_available": true, "constant_name": "SERVICE_ID_IS_NOT_FOUND" } ] } }, "get": { "operationId": "get-service-by-id", "tags": [ "services" ], "summary": "get-service-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "businessWeight": { "type": "number", "x-aura-field-code": "businessWeight" }, "cacheDuration": { "type": "integer", "format": "int32", "x-aura-field-code": "cacheDuration" }, "code": { "x-aura-type": "unresolved" }, "defaultOrderField": { "type": "string", "x-aura-field-code": "defaultOrderField" }, "defaultOrderType": { "type": "integer", "format": "int32", "x-aura-field-code": "defaultOrderType" }, "defaultPagingSize": { "type": "integer", "format": "int32", "x-aura-field-code": "defaultPagingSize" }, "domainId": { "type": "string", "format": "uuid", "x-aura-field-code": "domainId" }, "hasBpmVariable": { "type": "boolean", "x-aura-field-code": "hasBpmVariable" }, "hasFilter": { "type": "boolean", "x-aura-field-code": "hasFilter" }, "hasOrder": { "type": "boolean", "x-aura-field-code": "hasOrder" }, "hasPaging": { "type": "boolean", "x-aura-field-code": "hasPaging" }, "hasSharedCacheData": { "type": "boolean", "x-aura-field-code": "hasSharedCacheData" }, "hasTranslationData": { "type": "boolean", "x-aura-field-code": "hasTranslationData" }, "id": { "x-aura-type": "unresolved" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "isCacheable": { "type": "boolean", "x-aura-field-code": "isCacheable" }, "isLogDetailEnabled": { "type": "boolean", "x-aura-field-code": "isLogDetailEnabled" }, "isTransactional": { "type": "boolean", "x-aura-field-code": "isTransactional" }, "keywordIdList": { "type": "array", "items": { "type": "string", "format": "uuid", "x-aura-field-code": "keywordIdList" } }, "name": { "x-aura-type": "unresolved" }, "operationType": { "type": "integer", "format": "int32", "x-aura-field-code": "operationType" }, "path": { "type": "string", "x-aura-field-code": "path" }, "requestFieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "requestFieldId" }, "responseFieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "responseFieldId" }, "rollbackEventDefinitionId": { "type": "string", "format": "uuid", "x-aura-field-code": "rollbackEventDefinitionId" }, "rollbackServiceDefinitionId": { "type": "string", "format": "uuid", "x-aura-field-code": "rollbackServiceDefinitionId" }, "routingServiceDefinitionId": { "type": "string", "format": "uuid", "x-aura-field-code": "routingServiceDefinitionId" }, "serviceDefinitionRefreshCacheMapList": { "type": "array", "items": { "type": "object", "x-aura-field-code": "serviceDefinitionRefreshCacheMapList" } }, "serviceDefinitionRequestList": { "type": "array", "items": { "type": "object", "properties": { "customName": { "type": "string", "x-aura-field-code": "customName" }, "defaultValue": { "type": "string", "x-aura-field-code": "defaultValue" }, "fieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "fieldId" }, "location": { "type": "integer", "format": "int32", "x-aura-field-code": "location" }, "necessity": { "type": "integer", "format": "int32", "x-aura-field-code": "necessity" }, "necessityFormulaId": { "type": "string", "format": "uuid", "x-aura-field-code": "necessityFormulaId" }, "necessityLocalizationCode": { "type": "string", "x-aura-field-code": "necessityLocalizationCode" }, "parentServiceRequestId": { "type": "string", "format": "uuid", "x-aura-field-code": "parentServiceRequestId" }, "requestId": { "x-aura-type": "unresolved" }, "serviceRequestName": { "x-aura-type": "unresolved" }, "transactionalFieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "transactionalFieldId" } }, "x-aura-field-code": "requests" } }, "serviceDefinitionResponseList": { "type": "array", "items": { "type": "object", "properties": { "fieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "fieldId" }, "maskFormatId": { "type": "string", "format": "uuid", "x-aura-field-code": "maskFormatId" }, "parentServiceResponseId": { "type": "string", "format": "uuid", "x-aura-field-code": "parentServiceResponseId" }, "responseId": { "x-aura-type": "unresolved" }, "serviceResponseName": { "x-aura-type": "unresolved" } }, "x-aura-field-code": "responses" } }, "timeoutDuration": { "type": "integer", "format": "int64", "x-aura-field-code": "timeoutDuration" }, "translations": { "type": "array", "items": { "type": "object", "properties": { "languageCode": { "type": "string", "x-aura-field-code": "languageCode" }, "name": { "x-aura-type": "unresolved" } }, "x-aura-field-code": "translations" } }, "type": { "x-aura-type": "unresolved" }, "usageType": { "type": "integer", "format": "int32", "x-aura-field-code": "usageType" }, "validations": { "type": "array", "items": { "type": "object", "properties": { "id": { "x-aura-type": "unresolved" }, "serviceId": { "type": "string", "format": "uuid", "x-aura-field-code": "serviceId" }, "sortOrder": { "type": "number", "x-aura-field-code": "sortOrder" }, "validationId": { "type": "string", "format": "uuid", "x-aura-field-code": "validationId" } }, "x-aura-field-code": "validations" } }, "weight": { "type": "number", "x-aura-field-code": "weight" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-service-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "services/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ServiceDetailDto", "payload": "ServiceDetailDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "HasFilter", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "HasSharedCacheData", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "HasPaging", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "DefaultPagingSize", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "HasOrder", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "DefaultOrderField", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DefaultOrderType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsCacheable", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "CacheDuration", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "Path", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DomainId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "OperationType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Type", "declared_type": "int", "nullable": false, "collection": false }, { "name": "UsageType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Weight", "declared_type": "double?", "nullable": true, "collection": false }, { "name": "BusinessWeight", "declared_type": "double?", "nullable": true, "collection": false }, { "name": "HasBpmVariable", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "ResponseFieldDefinitionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "RequestFieldId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "IsTransactional", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "RoutingServiceDefinitionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "FraudServiceDefinitionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "IsRedirect", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "TimeoutDuration", "declared_type": "long?", "nullable": true, "collection": false }, { "name": "IsLogDetailEnabled", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "HasTranslationData", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "RollbackServiceDefinitionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "RollbackEventDefinitionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "KeywordIdList", "declared_type": "IEnumerable", "nullable": false, "collection": true }, { "name": "Translations", "declared_type": "IEnumerable", "nullable": false, "collection": true }, { "name": "ServiceDefinitionRequestList", "declared_type": "IEnumerable", "nullable": false, "collection": true }, { "name": "ServiceDefinitionResponseList", "declared_type": "IEnumerable", "nullable": false, "collection": true }, { "name": "ServiceDefinitionRefreshCacheMapList", "declared_type": "IEnumerable", "nullable": false, "collection": true }, { "name": "Validations", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." } }, "put": { "operationId": "aurax-bff-redirect-update-service-definition", "tags": [ "services" ], "summary": "aurax-bff-redirect-update-service-definition", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-service-definition", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "services/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/services/{id}/validations": { "get": { "operationId": "aurax-bff-redirect-get-service-definition-validation-list", "tags": [ "services" ], "summary": "aurax-bff-redirect-get-service-definition-validation-list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": false, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "This usage type is outside the invocation layer's filtered set, so that layer applies no binding-source filter at all and every declared source is passed through.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-service-definition-validation-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "services/{id}/validations", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "ServiceDefinitionValidationDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ServiceId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ValidationId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "SortOrder", "declared_type": "int", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-service-definition-validation-list", "target_dapr_app_id": "core-service", "target_route": "services/{id}/validations", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_CORE_40", "status": 400, "message": { "ar": "لم يتم العثور على معرف الخدمة.", "en": "Service cannot be found.", "tr": "Servis bulunamadı." }, "message_available": true, "constant_name": "SERVICE_ID_IS_NOT_FOUND" } ] } } }, "/slip-transactions": { "get": { "operationId": "aurax-bff-redirect-get-slip-transaction-list", "tags": [ "slip-transactions" ], "summary": "aurax-bff-redirect-get-slip-transaction-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": false, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "This usage type is outside the invocation layer's filtered set, so that layer applies no binding-source filter at all and every declared source is passed through.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-slip-transaction-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "slip-transactions", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "SlipTransactionDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "SlipData", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ChannelDefinitionId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "TemplateDesignContextId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "SlipId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "EntityName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Entityrowid", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ServiceDefinitionId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "TransactionDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "AccountingEntryId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "IsSlipGenerated", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "SlipNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransactionType", "declared_type": "int?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-slip-transaction-list", "target_dapr_app_id": "business-core-service", "target_route": "slip-transactions", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-slip-transaction", "tags": [ "slip-transactions" ], "summary": "aurax-bff-redirect-create-slip-transaction", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "query", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": false, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "This usage type is outside the invocation layer's filtered set, so that layer applies no binding-source filter at all and every declared source is passed through.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-slip-transaction", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "slip-transactions", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "SlipData", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChannelDefinitionId", "declared_type": null, "nullable": false, "collection": false }, { "name": "TemplateDesignContextId", "declared_type": null, "nullable": false, "collection": false }, { "name": "SlipId", "declared_type": null, "nullable": false, "collection": false }, { "name": "EntityName", "declared_type": null, "nullable": false, "collection": false }, { "name": "Entityrowid", "declared_type": null, "nullable": false, "collection": false }, { "name": "ServiceDefinitionId", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": true, "collection": false }, { "name": "AccountingEntryId", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsSlipGenerated", "declared_type": null, "nullable": false, "collection": false }, { "name": "SlipNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionType", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "command-id", "note": "The route returns `AuraCommandDto`, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, `Id`, of type `Guid`. A caller gets a JSON OBJECT with one field, not a bare value. The field is `id` on the wire.", "declared_type": "AuraCommandDto", "envelopes": [ "AuraCommandDto" ], "payload": "Guid", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false, "wire_name": "id", "wire_name_basis": "framework-naming-policy" } ], "naming": "Member names are the service's declaration names.", "synthesized": true, "forwarded": { "service_code": "create-slip-transaction", "target_dapr_app_id": "business-core-service", "target_route": "slip-transactions", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/slip-transactions/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-slip-transaction", "tags": [ "slip-transactions" ], "summary": "aurax-bff-redirect-delete-slip-transaction", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": false, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "This usage type is outside the invocation layer's filtered set, so that layer applies no binding-source filter at all and every declared source is passed through.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-slip-transaction", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "slip-transactions/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "forwarded": { "service_code": "delete-slip-transaction", "target_dapr_app_id": "business-core-service", "target_route": "slip-transactions/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_SLIP_3", "status": 400, "message": null, "message_available": false, "constant_name": "SLIP_TRANSACTION_IS_NOT_FOUND" } ] } }, "get": { "operationId": "aurax-bff-redirect-get-slip-transaction-by-id", "tags": [ "slip-transactions" ], "summary": "aurax-bff-redirect-get-slip-transaction-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": false, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "This usage type is outside the invocation layer's filtered set, so that layer applies no binding-source filter at all and every declared source is passed through.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-slip-transaction-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "slip-transactions/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "SlipTransactionDto", "payload": "SlipTransactionDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "SlipData", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ChannelDefinitionId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "TemplateDesignContextId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "SlipId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "EntityName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Entityrowid", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ServiceDefinitionId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "TransactionDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "AccountingEntryId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "IsSlipGenerated", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "SlipNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransactionType", "declared_type": "int?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-slip-transaction-by-id", "target_dapr_app_id": "business-core-service", "target_route": "slip-transactions/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_SLIP_3", "status": 400, "message": null, "message_available": false, "constant_name": "SLIP_TRANSACTION_IS_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-slip-transaction", "tags": [ "slip-transactions" ], "summary": "aurax-bff-redirect-update-slip-transaction", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "query", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": false, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "This usage type is outside the invocation layer's filtered set, so that layer applies no binding-source filter at all and every declared source is passed through.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-slip-transaction", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "slip-transactions/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "SlipData", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChannelDefinitionId", "declared_type": null, "nullable": false, "collection": false }, { "name": "TemplateDesignContextId", "declared_type": null, "nullable": false, "collection": false }, { "name": "SlipId", "declared_type": null, "nullable": false, "collection": false }, { "name": "EntityId", "declared_type": null, "nullable": false, "collection": false }, { "name": "Entityrowid", "declared_type": null, "nullable": false, "collection": false }, { "name": "ServiceDefinitionId", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": true, "collection": false }, { "name": "AccountingEntryId", "declared_type": null, "nullable": true, "collection": false }, { "name": "isSlipGenerated", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "forwarded": { "service_code": "update-slip-transaction", "target_dapr_app_id": "business-core-service", "target_route": "slip-transactions/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_SLIP_3", "status": 400, "message": null, "message_available": false, "constant_name": "SLIP_TRANSACTION_IS_NOT_FOUND" } ] } } }, "/slips": { "get": { "operationId": "aurax-bff-redirect-get-slip-list", "tags": [ "slips" ], "summary": "aurax-bff-redirect-get-slip-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": false, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "This usage type is outside the invocation layer's filtered set, so that layer applies no binding-source filter at all and every declared source is passed through.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-slip-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "slips", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "SlipDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Type", "declared_type": "int", "nullable": false, "collection": false }, { "name": "TemplateTypeId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "TemplateDesignId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "LanguageCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DmsPath", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SlipCode", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-slip-list", "target_dapr_app_id": "business-core-service", "target_route": "slips", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-slip", "tags": [ "slips" ], "summary": "aurax-bff-redirect-create-slip", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "query", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": false, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "This usage type is outside the invocation layer's filtered set, so that layer applies no binding-source filter at all and every declared source is passed through.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-slip", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "slips", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Type", "declared_type": null, "nullable": false, "collection": false }, { "name": "TemplateTypeId", "declared_type": null, "nullable": false, "collection": false }, { "name": "TemplateDesignId", "declared_type": null, "nullable": false, "collection": false }, { "name": "LanguageCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "DmsPath", "declared_type": null, "nullable": false, "collection": false }, { "name": "SlipCode", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "command-id", "note": "The route returns `AuraCommandDto`, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, `Id`, of type `Guid`. A caller gets a JSON OBJECT with one field, not a bare value. The field is `id` on the wire.", "declared_type": "AuraCommandDto", "envelopes": [ "AuraCommandDto" ], "payload": "Guid", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false, "wire_name": "id", "wire_name_basis": "framework-naming-policy" } ], "naming": "Member names are the service's declaration names.", "synthesized": true, "forwarded": { "service_code": "create-slip", "target_dapr_app_id": "business-core-service", "target_route": "slips", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_SLIP_1", "status": 400, "message": null, "message_available": false, "constant_name": "SLIP_ALREADY_EXIST" } ] } } }, "/slips/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-slip", "tags": [ "slips" ], "summary": "aurax-bff-redirect-delete-slip", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": false, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "This usage type is outside the invocation layer's filtered set, so that layer applies no binding-source filter at all and every declared source is passed through.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-slip", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "slips/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "forwarded": { "service_code": "delete-slip", "target_dapr_app_id": "business-core-service", "target_route": "slips/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_SLIP_2", "status": 400, "message": null, "message_available": false, "constant_name": "SLIP_IS_NOT_FOUND" } ] } }, "get": { "operationId": "aurax-bff-redirect-get-slip-by-id", "tags": [ "slips" ], "summary": "aurax-bff-redirect-get-slip-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": false, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "This usage type is outside the invocation layer's filtered set, so that layer applies no binding-source filter at all and every declared source is passed through.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-slip-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "slips/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "SlipDto", "payload": "SlipDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Type", "declared_type": "int", "nullable": false, "collection": false }, { "name": "TemplateTypeId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "TemplateDesignId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "LanguageCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DmsPath", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SlipCode", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-slip-by-id", "target_dapr_app_id": "business-core-service", "target_route": "slips/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_SLIP_2", "status": 400, "message": null, "message_available": false, "constant_name": "SLIP_IS_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-slip", "tags": [ "slips" ], "summary": "aurax-bff-redirect-update-slip", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "query", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": false, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "This usage type is outside the invocation layer's filtered set, so that layer applies no binding-source filter at all and every declared source is passed through.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-slip", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "slips/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Type", "declared_type": null, "nullable": false, "collection": false }, { "name": "TemplateTypeId", "declared_type": null, "nullable": false, "collection": false }, { "name": "TemplateDesignId", "declared_type": null, "nullable": false, "collection": false }, { "name": "LanguageCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "DmsPath", "declared_type": null, "nullable": false, "collection": false }, { "name": "SlipCode", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "forwarded": { "service_code": "update-slip", "target_dapr_app_id": "business-core-service", "target_route": "slips/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_SLIP_1", "status": 400, "message": null, "message_available": false, "constant_name": "SLIP_ALREADY_EXIST" }, { "code": "ERR_SLIP_2", "status": 400, "message": null, "message_available": false, "constant_name": "SLIP_IS_NOT_FOUND" } ] } } }, "/tax-offices": { "get": { "operationId": "aurax-bff-dynamic-get-tax-office-list", "tags": [ "tax-offices" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-tax-office-list", "description": "Request and response fields are declared on the routing target `get-tax-office-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "taxOfficeName" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "taxOfficeId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "name": { "type": "string", "x-aura-field-code": "taxOfficeCode" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-tax-office-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "tax-offices", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-tax-office-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "post": { "operationId": "aurax-bff-service-dynamic-create-tax-office", "tags": [ "tax-offices" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-create-tax-office", "description": "Request and response fields are declared on the routing target `create-tax-office`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "taxOfficeCode" }, "name": { "type": "string", "x-aura-field-code": "taxOfficeName" } }, "required": [ "code", "name" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 2, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "taxOfficeId" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "taxOfficeId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "taxOfficeId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-create-tax-office", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "tax-offices", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/tax-offices/{id}": { "delete": { "operationId": "aurax-bff-service-dynamic-delete-tax-office", "tags": [ "tax-offices" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-service-dynamic-delete-tax-office", "description": "Invokes the `aurax-bff-service-dynamic-delete-tax-office` service definition through `DELETE /tax-offices/{id}`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "taxOfficeId" } } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": false, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "This usage type is outside the invocation layer's filtered set, so that layer applies no binding-source filter at all and every declared source is passed through.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-delete-tax-office", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "tax-offices/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "get": { "operationId": "aurax-bff-dynamic-get-tax-office-by-id", "tags": [ "tax-offices" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-get-tax-office-by-id", "description": "Request and response fields are declared on the routing target `get-tax-office-by-id`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "taxOfficeId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "taxOfficeCode" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "taxOfficeId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "name": { "type": "string", "x-aura-field-code": "taxOfficeName" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-get-tax-office-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "tax-offices/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "put": { "operationId": "aurax-bff-service-dynamic-update-tax-office", "tags": [ "tax-offices" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "update-tax-office", "description": "Invokes the `aurax-bff-service-dynamic-update-tax-office` service definition through `PUT /tax-offices/{id}`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "taxOfficeId" } } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "query", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": false, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "This usage type is outside the invocation layer's filtered set, so that layer applies no binding-source filter at all and every declared source is passed through.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-service-dynamic-update-tax-office", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "tax-offices/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/taxes": { "get": { "operationId": "aurax-bff-redirect-get-tax-list", "tags": [ "taxes" ], "summary": "aurax-bff-redirect-get-tax-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-tax-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "taxes", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Filter", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "TaxDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FromProperty", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TaxCondition", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Type", "declared_type": "int", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-tax-list", "target_dapr_app_id": "business-core-service", "target_route": "taxes", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-tax-definition-ui-bpmn", "tags": [ "taxes" ], "summary": "aurax-bff-redirect-create-tax-definition-ui-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-tax-definition-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "taxes", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Code", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "FromProperty", "declared_type": null, "nullable": false, "collection": false }, { "name": "TaxCondition", "declared_type": null, "nullable": false, "collection": false }, { "name": "Type", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/taxes/by-code/{code}": { "get": { "operationId": "aurax-bff-redirect-get-tax-by-code", "tags": [ "taxes" ], "summary": "aurax-bff-redirect-get-tax-by-code", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-tax-by-code", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "taxes/by-code/{code}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Code", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "TaxDto", "payload": "TaxDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FromProperty", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TaxCondition", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Type", "declared_type": "int", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-tax-by-code", "target_dapr_app_id": "business-core-service", "target_route": "taxes/by-code/{code}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_TX_2", "status": 400, "message": null, "message_available": false, "constant_name": "TAX_NOT_FOUND" } ] } } }, "/taxes/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-tax-definition-ui-bpmn", "tags": [ "taxes" ], "summary": "aurax-bff-redirect-delete-tax-definition-ui-bpmn", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-tax-definition-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "taxes/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "get": { "operationId": "aurax-bff-redirect-get-tax-by-id", "tags": [ "taxes" ], "summary": "aurax-bff-redirect-get-tax-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-tax-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "taxes/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "TaxDto", "payload": "TaxDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FromProperty", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TaxCondition", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Type", "declared_type": "int", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-tax-by-id", "target_dapr_app_id": "business-core-service", "target_route": "taxes/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_TX_2", "status": 400, "message": null, "message_available": false, "constant_name": null } ] } }, "put": { "operationId": "aurax-bff-redirect-update-tax-definition-ui-bpmn", "tags": [ "taxes" ], "summary": "aurax-bff-redirect-update-tax-definition-ui-bpmn", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-tax-definition-ui-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "taxes/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "FromProperty", "declared_type": null, "nullable": false, "collection": false }, { "name": "TaxCondition", "declared_type": null, "nullable": false, "collection": false }, { "name": "Type", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/taxes/{id}/available-rate": { "get": { "operationId": "aurax-bff-redirect-get-tax-available-rate", "tags": [ "taxes" ], "summary": "aurax-bff-redirect-get-tax-available-rate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-tax-available-rate", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "taxes/{id}/available-rate", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "TransactionAmount", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "TaxAvailableRateDto", "payload": "TaxAvailableRateDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FromProperty", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TaxCondition", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Type", "declared_type": "int", "nullable": false, "collection": false }, { "name": "TaxRateId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ValidityBeginDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "ValidityEndDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "Rate", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "MinimumAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "MaximumAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "FixedAmount", "declared_type": "decimal?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-tax-available-rate", "target_dapr_app_id": "business-core-service", "target_route": "taxes/{id}/available-rate", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_TX_2", "status": 400, "message": null, "message_available": false, "constant_name": "TAX_NOT_FOUND" }, { "code": "ERR_TX_3", "status": 400, "message": null, "message_available": false, "constant_name": "TAX_RATE_NOT_FOUND" } ] } } }, "/taxes/{id}/details": { "get": { "operationId": "aurax-bff-redirect-get-tax-detail", "tags": [ "taxes" ], "summary": "aurax-bff-redirect-get-tax-detail", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-tax-detail", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "taxes/{id}/details", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "TaxDetailDto", "payload": "TaxDetailDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FromProperty", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TaxCondition", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Type", "declared_type": "int", "nullable": false, "collection": false }, { "name": "TaxRates", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-tax-detail", "target_dapr_app_id": "business-core-service", "target_route": "taxes/{id}/details", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_TX_2", "status": 400, "message": null, "message_available": false, "constant_name": "TAX_NOT_FOUND" } ] } } }, "/template-types": { "get": { "operationId": "aurax-bff-redirect-get-template-type-list", "tags": [ "template-types" ], "summary": "aurax-bff-redirect-get-template-type-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-template-type-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "template-types", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "TemplateTypeDto", "collection": true, "members": [ { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DocumentFormat", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CategoryType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Tools", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-template-type-list", "target_dapr_app_id": "template-management-service", "target_route": "template-types", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-template-type-bpmn", "tags": [ "template-types" ], "summary": "aurax-bff-redirect-create-template-type-bpmn", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-template-type-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "template-types", "x-aura-request-contract": { "state": "no-members" }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/template-types/designs/create-document-by-code/{templateDesignCode}": { "post": { "operationId": "aurax-bff-redirect-create-document-by-code-with-template-bpmn", "tags": [ "template-types" ], "summary": "aurax-bff-redirect-create-document-by-code-with-template-bpmn", "parameters": [ { "name": "templateDesignCode", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-document-by-code-with-template-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "template-types/designs/create-document-by-code/{templateDesignCode}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "TemplateDesignCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "LanguageCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "DesignVariables", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsResponseClear", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/template-types/designs/create-document/{templateDesignId}": { "post": { "operationId": "aurax-bff-redirect-create-document-with-template-bpmn", "tags": [ "template-types" ], "summary": "aurax-bff-redirect-create-document-with-template-bpmn", "parameters": [ { "name": "templateDesignId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-document-with-template-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "template-types/designs/create-document/{templateDesignId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "TemplateDesignId", "declared_type": null, "nullable": false, "collection": false }, { "name": "LanguageCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "DesignVariables", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsResponseClear", "declared_type": null, "nullable": true, "collection": false }, { "name": "TemplateDesignContextId", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsPdf", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/template-types/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-template-type-bpmn", "tags": [ "template-types" ], "summary": "aurax-bff-redirect-delete-template-type-bpmn", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-template-type-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "template-types/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "get": { "operationId": "aurax-bff-redirect-get-template-type-by-id", "tags": [ "template-types" ], "summary": "aurax-bff-redirect-get-template-type-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-template-type-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "template-types/{id}", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "TemplateTypeDto", "payload": "TemplateTypeDto", "collection": false, "members": [ { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DocumentFormat", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CategoryType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Tools", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-template-type-by-id", "target_dapr_app_id": "template-management-service", "target_route": "template-types/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_TMPLMNG_2", "status": 400, "message": { "ar": "لا يمكن العثور على نوع القالب باستخدام: {0}.", "en": "Template type is cannot be found with the given :{0}.", "tr": "Verilen kimlikle şablon türü bulunamadı: {0}." }, "message_available": true, "constant_name": "TEMPLATE_TYPE_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-template-type-and-create-delete-template-type-tool-bpmn", "tags": [ "template-types" ], "summary": "aurax-bff-redirect-update-template-type-and-create-delete-template-type-tool-bpmn", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-template-type-and-create-delete-template-type-tool-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "template-types/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/template-types/{id}/designs": { "get": { "operationId": "aurax-bff-redirect-get-template-design-list", "tags": [ "template-types" ], "summary": "aurax-bff-redirect-get-template-design-list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-template-design-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "template-types/{id}/designs", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "TemplateDesignDto", "collection": true, "members": [ { "name": "TemplateDesignId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsImmediateDesign", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "ActiveContextVersion", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TemplateDesignExtensions", "declared_type": "Dictionary", "nullable": false, "collection": false }, { "name": "TemplateDesignFields", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-template-design-list", "target_dapr_app_id": "template-management-service", "target_route": "template-types/{id}/designs", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_TMPLMNG_2", "status": 400, "message": { "ar": "لا يمكن العثور على نوع القالب باستخدام: {0}.", "en": "Template type is cannot be found with the given :{0}.", "tr": "Verilen kimlikle şablon türü bulunamadı: {0}." }, "message_available": true, "constant_name": "TEMPLATE_TYPE_NOT_FOUND" } ] } }, "post": { "operationId": "aurax-bff-redirect-create-template-design-bpmn", "tags": [ "template-types" ], "summary": "aurax-bff-redirect-create-template-design-bpmn", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-template-design-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "template-types/{id}/designs", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "TemplateDesignExtensions", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/template-types/{id}/designs/{templateDesignId}": { "delete": { "operationId": "aurax-bff-redirect-delete-template-design-bpmn", "tags": [ "template-types" ], "summary": "aurax-bff-redirect-delete-template-design-bpmn", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "templateDesignId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-template-design-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "template-types/{id}/designs/{templateDesignId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "TemplateDesignId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "get": { "operationId": "aurax-bff-redirect-get-template-design-by-id", "tags": [ "template-types" ], "summary": "aurax-bff-redirect-get-template-design-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "templateDesignId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-template-design-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "template-types/{id}/designs/{templateDesignId}", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "TemplateDesignDto", "payload": "TemplateDesignDto", "collection": false, "members": [ { "name": "TemplateDesignId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsImmediateDesign", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "ActiveContextVersion", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TemplateDesignExtensions", "declared_type": "Dictionary", "nullable": false, "collection": false }, { "name": "TemplateDesignFields", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-template-design-by-id", "target_dapr_app_id": "template-management-service", "target_route": "template-types/{id}/designs/{templateDesignId}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_TMPLMNG_2", "status": 400, "message": { "ar": "لا يمكن العثور على نوع القالب باستخدام: {0}.", "en": "Template type is cannot be found with the given :{0}.", "tr": "Verilen kimlikle şablon türü bulunamadı: {0}." }, "message_available": true, "constant_name": "TEMPLATE_TYPE_NOT_FOUND" }, { "code": "ERR_TMPLMNG_6", "status": 400, "message": { "ar": "لا يمكن العثور على قالب التصميم باستخدام: {0}.", "en": "Template design is cannot be found with the given :{0}.", "tr": "Şablon tasarımı bulunamadı: {0}." }, "message_available": true, "constant_name": "TEMPLATE_DESIGN_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-template-design-and-create-template-design-field-bpmn", "tags": [ "template-types" ], "summary": "aurax-bff-redirect-update-template-design-and-create-template-design-field-bpmn", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only", "x-aura-catalog-parameter-name": "templateTypeId" }, { "name": "templateDesignId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-template-design-and-create-template-design-field-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "template-types/{templateTypeId}/designs/{templateDesignId}", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." }, "x-aura-path-template-merged": { "catalog_template": "/template-types/{templateTypeId}/designs/{templateDesignId}", "published_template": "/template-types/{id}/designs/{templateDesignId}", "renamed": { "templateTypeId": "id" }, "reason": "OpenAPI 3.1 §4.8.8 — paths differing only in template variable names are identical and MUST NOT coexist. A path parameter name is local to the template and positional on the wire, so this rename does not change the request; the catalog names are preserved on each parameter and here." } } }, "/template-types/{id}/designs/{templateDesignId}/contexts": { "post": { "operationId": "aurax-bff-redirect-create-template-design-context-bpmn", "tags": [ "template-types" ], "summary": "aurax-bff-redirect-create-template-design-context-bpmn", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "templateDesignId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-template-design-context-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "template-types/{id}/designs/{templateDesignId}/contexts", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "TemplateDesignId", "declared_type": null, "nullable": false, "collection": false }, { "name": "Context", "declared_type": null, "nullable": false, "collection": false }, { "name": "LanguageCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsDefault", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/template-types/{id}/designs/{templateDesignId}/contexts/by-language-code/{languageCode}": { "get": { "operationId": "aurax-bff-redirect-get-template-design-context-list", "tags": [ "template-types" ], "summary": "aurax-bff-redirect-get-template-design-context-list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "templateDesignId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "languageCode", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-template-design-context-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "template-types/{id}/designs/{templateDesignId}/contexts/by-language-code/{languageCode}", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "DesignContextDto", "collection": true, "members": [ { "name": "TemplateDesignContextId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ContextVersion", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "IsDefault", "declared_type": "bool?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-template-design-context-list", "target_dapr_app_id": "template-management-service", "target_route": "template-types/{id}/designs/{templateDesignId}/contexts/by-language-code/{languageCode}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_TMPLMNG_2", "status": 400, "message": { "ar": "لا يمكن العثور على نوع القالب باستخدام: {0}.", "en": "Template type is cannot be found with the given :{0}.", "tr": "Verilen kimlikle şablon türü bulunamadı: {0}." }, "message_available": true, "constant_name": "TEMPLATE_TYPE_NOT_FOUND" }, { "code": "ERR_TMPLMNG_6", "status": 400, "message": { "ar": "لا يمكن العثور على قالب التصميم باستخدام: {0}.", "en": "Template design is cannot be found with the given :{0}.", "tr": "Şablon tasarımı bulunamadı: {0}." }, "message_available": true, "constant_name": "TEMPLATE_DESIGN_NOT_FOUND" } ] } } }, "/template-types/{id}/designs/{templateDesignId}/contexts/{templateDesignContextId}": { "get": { "operationId": "aurax-bff-redirect-get-template-design-context-by-id", "tags": [ "template-types" ], "summary": "aurax-bff-redirect-get-template-design-context-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "templateDesignId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "templateDesignContextId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-template-design-context-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "template-types/{id}/designs/{templateDesignId}/contexts/{templateDesignContextId}", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "TemplateDesignContextAndEntitiesDto", "payload": "TemplateDesignContextAndEntitiesDto", "collection": false, "members": [ { "name": "TemplateDesignContextId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ContextVersion", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Context", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LanguageCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "IsDefault", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "TemplateDesignFields", "declared_type": "List", "nullable": false, "collection": true }, { "name": "TemplateDesignTools", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-template-design-context-by-id", "target_dapr_app_id": "template-management-service", "target_route": "template-types/{id}/designs/{templateDesignId}/contexts/{templateDesignContextId}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_TMPLMNG_2", "status": 400, "message": { "ar": "لا يمكن العثور على نوع القالب باستخدام: {0}.", "en": "Template type is cannot be found with the given :{0}.", "tr": "Verilen kimlikle şablon türü bulunamadı: {0}." }, "message_available": true, "constant_name": "TEMPLATE_TYPE_NOT_FOUND" }, { "code": "ERR_TMPLMNG_6", "status": 400, "message": { "ar": "لا يمكن العثور على قالب التصميم باستخدام: {0}.", "en": "Template design is cannot be found with the given :{0}.", "tr": "Şablon tasarımı bulunamadı: {0}." }, "message_available": true, "constant_name": "TEMPLATE_DESIGN_NOT_FOUND" }, { "code": "ERR_TMPLMNG_8", "status": 400, "message": { "ar": "لا يمكن العثور على سياق تصميم القالب باستخدام: {0}.", "en": "Template design context is cannot be found with the given: {0}.", "tr": "Şablon tasarım içeriği bulunamadı: {0}." }, "message_available": true, "constant_name": "TEMPLATE_DESIGN_CONTEXT_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-template-design-context-bpmn", "tags": [ "template-types" ], "summary": "aurax-bff-redirect-update-template-design-context-bpmn", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "templateDesignId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "templateDesignContextId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-template-design-context-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "template-types/{id}/designs/{templateDesignId}/contexts/{templateDesignContextId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "TemplateDesignId", "declared_type": null, "nullable": false, "collection": false }, { "name": "TemplateDesignContextId", "declared_type": null, "nullable": false, "collection": false }, { "name": "Context", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsDefault", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/template-types/{id}/designs/{templateDesignId}/contexts/{templateDesignContextId}/active": { "put": { "operationId": "aurax-bff-redirect-update-template-design-context-status", "tags": [ "template-types" ], "summary": "aurax-bff-redirect-update-template-design-context-status", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "templateDesignId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "templateDesignContextId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-template-design-context-status", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "template-types/{id}/designs/{templateDesignId}/contexts/{templateDesignContextId}/active", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "TemplateDesignId", "declared_type": null, "nullable": false, "collection": false }, { "name": "TemplateDesignContextId", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "forwarded": { "service_code": "update-template-design-context-status", "target_dapr_app_id": "template-management-service", "target_route": "template-types/{id}/designs/{templateDesignId}/contexts/{templateDesignContextId}/active", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_TMPLMNG_2", "status": 400, "message": { "ar": "لا يمكن العثور على نوع القالب باستخدام: {0}.", "en": "Template type is cannot be found with the given :{0}.", "tr": "Verilen kimlikle şablon türü bulunamadı: {0}." }, "message_available": true, "constant_name": "TEMPLATE_TYPE_NOT_FOUND" }, { "code": "ERR_TMPLMNG_6", "status": 400, "message": { "ar": "لا يمكن العثور على قالب التصميم باستخدام: {0}.", "en": "Template design is cannot be found with the given :{0}.", "tr": "Şablon tasarımı bulunamadı: {0}." }, "message_available": true, "constant_name": "TEMPLATE_DESIGN_NOT_FOUND" }, { "code": "ERR_TMPLMNG_8", "status": 400, "message": { "ar": "لا يمكن العثور على سياق تصميم القالب باستخدام: {0}.", "en": "Template design context is cannot be found with the given: {0}.", "tr": "Şablon tasarım içeriği bulunamadı: {0}." }, "message_available": true, "constant_name": "TEMPLATE_DESIGN_CONTEXT_NOT_FOUND" } ] } } }, "/template-types/{id}/designs/{templateDesignId}/fields-and-tools": { "get": { "operationId": "aurax-bff-redirect-get-template-design-fields-and-tools", "tags": [ "template-types" ], "summary": "aurax-bff-redirect-get-template-design-fields-and-tools", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "templateDesignId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-template-design-fields-and-tools", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "template-types/{id}/designs/{templateDesignId}/fields-and-tools", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "TemplateDesignId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "TemplateDesignContextAndEntitiesDto", "payload": "TemplateDesignContextAndEntitiesDto", "collection": false, "members": [ { "name": "TemplateDesignContextId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ContextVersion", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Context", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LanguageCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "IsDefault", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "TemplateDesignFields", "declared_type": "List", "nullable": false, "collection": true }, { "name": "TemplateDesignTools", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-template-design-fields-and-tools", "target_dapr_app_id": "template-management-service", "target_route": "template-types/{id}/designs/{templateDesignId}/fields-and-tools", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/tenants/current": { "get": { "operationId": "aurax-bff-get-current-tenant", "tags": [ "tenants" ], "summary": "aurax-bff-get-current-tenant", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-get-current-tenant", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "tenants/current", "x-aura-request-contract": { "state": "no-members" }, "x-aura-code-response": { "state": "structure", "declared_type": "TenantDto", "payload": "TenantDto", "collection": false, "members": [ { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CountryId", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Currency", "declared_type": "Currency", "nullable": false, "collection": false }, { "name": "LanguageCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Realm", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TimeOffset", "declared_type": "TimeSpan", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/tenants/current/configs": { "get": { "operationId": "aurax-bff-redirect-get-current-tenant-config-list", "tags": [ "tenants" ], "summary": "aurax-bff-redirect-get-current-tenant-config-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-current-tenant-config-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "tenants/current/configs", "x-aura-request-contract": { "state": "no-members" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "TempCurrentConfigDto", "collection": true, "members": [ { "name": "ConfigId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ConfigCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FieldValue", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-current-tenant-config-list", "target_dapr_app_id": "core-service", "target_route": "tenants/current/configs", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/tenants/current/domains": { "get": { "operationId": "aurax-bff-redirect-get-current-tenant-domain-list", "tags": [ "tenants" ], "summary": "aurax-bff-redirect-get-current-tenant-domain-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-current-tenant-domain-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "tenants/current/domains", "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "DomainDefinitionDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DaprAppId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DaprNamespace", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Url", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ParentDomainId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "HasCompensation", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "Priority", "declared_type": "int", "nullable": false, "collection": false }, { "name": "HasBpm", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "Translations", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-current-tenant-domain-list", "target_dapr_app_id": "core-service", "target_route": "tenants/domains", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/tenants/current/languages": { "get": { "operationId": "aurax-bff-get-current-tenant-language-list", "tags": [ "tenants" ], "summary": "aurax-bff-get-current-tenant-language-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-get-current-tenant-language-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "tenants/current/languages", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "no-members" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "LanguageDto", "collection": true, "members": [ { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsRtl", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Alpha2", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Alpha3", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Translations", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." } } }, "/test-dist-event-bpm": { "post": { "operationId": "aurax-bff-test-dist-event-bpm", "tags": [ "test-dist-event-bpm" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-test-dist-event-bpm", "description": "Request and response fields are declared on the routing target `test-dist-event-bpm`; this entry declares none of its own.", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-test-dist-event-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "test-dist-event-bpm", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/testurlpath": { "post": { "operationId": "aurax-bff-redirect-authorization-check-resource-by-realm-partner", "tags": [ "testurlpath" ], "summary": "aurax-bff-redirect-authorization-check-resource-by-realm-partner", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "query", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": false, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "This usage type is outside the invocation layer's filtered set, so that layer applies no binding-source filter at all and every declared source is passed through.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-authorization-check-resource-by-realm-partner", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "testurlpath", "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/time-deposits/by-account-id/{accountId}/preview/early-withdrawal": { "get": { "operationId": "aurax-bff-redirect-get-interest-break-amount-by-account-id", "tags": [ "time-deposits" ], "summary": "aurax-bff-redirect-get-interest-break-amount-by-account-id", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-interest-break-amount-by-account-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "time-deposits/by-account-id/{accountId}/preview/early-withdrawal", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "AccountId", "declared_type": null, "nullable": false, "collection": false }, { "name": "AvailableBalance", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "InterestBreakAmountDto", "payload": "InterestBreakAmountDto", "collection": false, "members": [ { "name": "StartDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "EndDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "Principal", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "AfterPenaltyAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "NetPeriod", "declared_type": "int?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-interest-break-amount-by-account-id", "target_dapr_app_id": "time-deposit-service", "target_route": "time-deposits/by-account-id/{accountId}/preview/early-withdrawal", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_TMDPST_8", "status": 400, "message": null, "message_available": false, "constant_name": "NO_ACCOUNT_DETAIL_FOUND_FOR_REQUESTED_ACCOUNT" }, { "code": "ERR_TMDPST_9", "status": 400, "message": null, "message_available": false, "constant_name": "NO_VALID_ACCOUNT_DETAIL_FOUND_FOR_REQUESTED_ACCOUNT" } ] } } }, "/time-deposits/by-account-id/{accountId}/preview/maturity-end": { "get": { "operationId": "aurax-bff-redirect-get-interest-amount-by-account-id", "tags": [ "time-deposits" ], "summary": "aurax-bff-redirect-get-interest-amount-by-account-id", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-interest-amount-by-account-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "time-deposits/by-account-id/{accountId}/preview/maturity-end", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "AccountId", "declared_type": null, "nullable": false, "collection": false }, { "name": "AvailableBalance", "declared_type": null, "nullable": false, "collection": false }, { "name": "InterestRate", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/time-deposits/by-account-product-id/{accountProductId}/preview/interest-amount": { "get": { "operationId": "aurax-bff-redirect-get-interest-amount-by-product-id", "tags": [ "time-deposits" ], "summary": "aurax-bff-redirect-get-interest-amount-by-product-id", "parameters": [ { "name": "accountProductId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-interest-amount-by-product-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "time-deposits/by-account-product-id/{accountProductId}/preview/interest-amount", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "AccountProductId", "declared_type": null, "nullable": false, "collection": false }, { "name": "Amount", "declared_type": null, "nullable": true, "collection": false }, { "name": "MaturityPeriod", "declared_type": null, "nullable": true, "collection": false }, { "name": "MaturityEndDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "ContributionRate", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "InterestAmountDto", "payload": "InterestAmountDto", "collection": false, "members": [ { "name": "Principal", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "GrossReturn", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "Tax", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "NetReturn", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "EndOfMaturityTotal", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "MaturityDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "StartDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "MaturityPeriod", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ContributionRate", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "AccountProductContributionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "RenewalDetail", "declared_type": "RenewalDetailDto", "nullable": false, "collection": false }, { "name": "TaxList", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-interest-amount-by-product-id", "target_dapr_app_id": "time-deposit-service", "target_route": "time-deposits/by-account-product-id/{accountProductId}/preview/interest-amount", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_TMDPST_14", "status": 400, "message": null, "message_available": false, "constant_name": "MUST_BE_MATURITY_PERIOD_OR_MATURITY_END_DATE_FOR_REQUESTED_AMOUNT" }, { "code": "ERR_TMDPST_15", "status": 400, "message": null, "message_available": false, "constant_name": "NO_PRODUCT_CONTRIBUTION_FOUND_FOR_REQUESTED_MATURITY" }, { "code": "ERR_TMDPST_4", "status": 400, "message": null, "message_available": false, "constant_name": "NO_PRODUCT_CONTRIBUTION_FOUND_FOR_REQUESTED_AMOUNT" } ] } } }, "/trial-balance": { "get": { "operationId": "aurax-bff-get-trial-balance", "tags": [ "trial-balance" ], "summary": "aurax-bff-get-trial-balance", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-get-trial-balance", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "trial-balance", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "BeginDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "EndDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "LedgerLevel", "declared_type": null, "nullable": true, "collection": false }, { "name": "LedgerCodeBegin", "declared_type": null, "nullable": false, "collection": false }, { "name": "LedgerCodeEnd", "declared_type": null, "nullable": false, "collection": false }, { "name": "WithGLCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "WithAccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "WithOrganizationCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrganizationCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExcludeYearEndClosingEntry", "declared_type": null, "nullable": false, "collection": false }, { "name": "ShowZeroBalance", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsEvaluationDateToday", "declared_type": null, "nullable": false, "collection": false }, { "name": "CurrencyNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExchangeSpreadType", "declared_type": null, "nullable": true, "collection": false }, { "name": "ExchangeRateType", "declared_type": null, "nullable": true, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "`TrialBalanceItem` is not among the C# declarations parsed from this repository. The resolver checks this repository first, then permits a lookup in `aura/framework` or `aura/kernel` only when this repository declares the matching 0.2-line PackageReference. This unresolved verdict means neither licensed lookup produced exactly one parsed declaration. The view does not expose whether that was because no eligible package proof exists or because the entitled platform source does not declare the name, so this page does not guess between them. It is a dependency-boundary gap in what this portal can resolve, not evidence that the service returns no body.", "declared_type": "PagedResultDto", "envelopes": [ "PagedResultDto" ], "payload": "TrialBalanceItem" } } }, "/unlimited-company-customers": { "post": { "operationId": "aurax-bff-redirect-create-unlimited-company-customer-ui-bpm", "tags": [ "unlimited-company-customers" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-create-unlimited-company-customer-ui-bpm", "description": "Request and response fields are declared on the routing target `create-unlimited-company-customer-ui-bpm`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "addressFields": { "type": "array", "items": { "type": "object", "properties": { "fieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "addressTypeFieldId" }, "fieldValue": { "type": "string", "x-aura-field-code": "addressTypeFieldValue" } }, "x-aura-field-code": "addressFields" } }, "addressName": { "type": "string", "x-aura-field-code": "addressName" }, "addressType": { "type": "integer", "format": "int32", "x-aura-field-code": "addressType" }, "addressTypeId": { "type": "string", "format": "uuid", "x-aura-field-code": "addressTypeId" }, "building": { "type": "integer", "format": "int32", "x-aura-field-code": "country" }, "country": { "type": "integer", "format": "int32", "x-aura-field-code": "country" }, "district": { "type": "integer", "format": "int32", "x-aura-field-code": "country" }, "division": { "type": "integer", "format": "int32", "x-aura-field-code": "country" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "addressId" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "neighbourhood": { "type": "integer", "format": "int32", "x-aura-field-code": "country" }, "postCode": { "type": "string", "x-aura-field-code": "postCode" }, "rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "section": { "type": "integer", "format": "int32", "x-aura-field-code": "country" }, "street": { "type": "integer", "format": "int32", "x-aura-field-code": "country" } }, "required": [ "_rowStatus", "addressFields", "addressType", "addressTypeId", "isContact", "isDefault" ], "x-aura-field-code": "addresses" } }, "birthCountryId": { "type": "integer", "format": "int32", "x-aura-field-code": "birthCountryId" }, "birthDate": { "type": "string", "format": "date", "x-aura-field-code": "birthDate" }, "birthPlace": { "type": "string", "x-aura-field-code": "birthPlace" }, "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "citizenidType": { "type": "integer", "format": "int32", "x-aura-field-code": "citizenidType" }, "consentItemIds": { "type": "array", "items": { "type": "string", "x-aura-field-code": "consentItemIds" } }, "createdOrganizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "createdOrganizationId" }, "customerNumber": { "type": "string", "x-aura-field-code": "customerNumber" }, "customerSubType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerSubType" }, "customerTaxpayers": { "type": "array", "items": { "type": "object", "properties": { "countryId": { "type": "integer", "format": "int32", "x-aura-field-code": "countryId" }, "description": { "type": "string", "x-aura-field-code": "description" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "taxpayerId" }, "taxNumber": { "type": "string", "x-aura-field-code": "taxNumber" }, "taxpayerType": { "type": "integer", "format": "int32", "x-aura-field-code": "taxpayerType" } }, "required": [ "countryId", "id", "taxNumber", "taxpayerType" ], "x-aura-field-code": "customerTaxpayers" } }, "customerType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerType" }, "deathDate": { "type": "string", "format": "date", "x-aura-field-code": "deathDate" }, "dmsId": { "type": "string", "format": "uuid", "x-aura-field-code": "dmsId" }, "emails": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "email": { "type": "string", "x-aura-field-code": "email" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "emailId" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" } }, "required": [ "_rowStatus", "email", "isContact", "isDefault" ], "x-aura-field-code": "emails" } }, "establishedDate": { "type": "string", "format": "date", "x-aura-field-code": "establishedDate" }, "fatherName": { "type": "string", "x-aura-field-code": "fatherName" }, "fullName": { "type": "string", "x-aura-field-code": "fullName" }, "gender": { "type": "integer", "format": "int32", "x-aura-field-code": "gender" }, "givenName": { "type": "string", "x-aura-field-code": "givenName" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "identities": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "identityFields": { "type": "array", "items": { "type": "object", "properties": { "fieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "identityTypeFieldId" }, "fieldValue": { "type": "string", "x-aura-field-code": "identityTypeFieldValue" } }, "required": [ "fieldId", "fieldValue" ], "x-aura-field-code": "identityTypeFields" } }, "identityTypeId": { "type": "string", "format": "uuid", "x-aura-field-code": "identityTypeId" } }, "required": [ "_rowStatus", "identityFields", "identityTypeId" ], "x-aura-field-code": "identities" } }, "isPoliticallyExposed": { "type": "boolean", "x-aura-field-code": "isPoliticallyExposed" }, "maidenSurname": { "type": "string", "x-aura-field-code": "maidenSurname" }, "mainOrganizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "mainOrganizationId" }, "maritalStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "maritalStatus" }, "middleName": { "type": "string", "x-aura-field-code": "middleName" }, "motherMaidenSurname": { "type": "string", "x-aura-field-code": "motherMaidenSurname" }, "motherName": { "type": "string", "x-aura-field-code": "motherName" }, "name": { "type": "string", "x-aura-field-code": "firstName" }, "nationalities": { "type": "array", "items": { "type": "object", "properties": { "countryId": { "type": "integer", "format": "int32", "x-aura-field-code": "countryId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "nationalityId" }, "priority": { "type": "integer", "format": "int32", "x-aura-field-code": "priority" } }, "required": [ "countryId", "priority" ], "x-aura-field-code": "nationalities" } }, "occupations": { "type": "array", "items": { "type": "object", "properties": { "fieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "occupationTypeFieldId" }, "typeId": { "type": "string", "format": "uuid", "x-aura-field-code": "occupationTypeId" } }, "required": [ "fieldId", "typeId" ], "x-aura-field-code": "occupations" } }, "onboardedOrganizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "onboardedOrganizationId" }, "personRegistration": { "type": "boolean", "x-aura-field-code": "personRegistration" }, "phones": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "phoneId" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "phoneNumber": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true }, "phoneType": { "type": "integer", "format": "int32", "x-aura-field-code": "phoneType" } }, "required": [ "isContact", "isDefault", "phoneNumber", "phoneType" ], "x-aura-field-code": "phones" } }, "profiles": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "profileId" }, "profile": { "type": "integer", "format": "int32", "x-aura-field-code": "profile" } }, "x-aura-field-code": "profiles" } }, "relations": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "_rowStatus" }, "description": { "type": "string", "x-aura-field-code": "authorityDescription" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "relationType": { "type": "integer", "format": "int32", "x-aura-field-code": "relationType" }, "startDate": { "type": "string", "format": "date-time", "x-aura-field-code": "startDate" }, "toCitizenid": { "type": "string", "x-aura-field-code": "toCitizenid" }, "toCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "toCustomerId" } }, "x-aura-field-code": "relations" } }, "reserveCustomerNumber": { "type": "boolean", "x-aura-field-code": "reserveCustomerNumber" }, "residency": { "type": "integer", "format": "int32", "x-aura-field-code": "residency" }, "residentials": { "type": "array", "items": { "type": "object", "properties": { "countryId": { "type": "integer", "format": "int32", "x-aura-field-code": "countryId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "residentialId" }, "priority": { "type": "integer", "format": "int32", "x-aura-field-code": "priority" } }, "required": [ "countryId", "priority" ], "x-aura-field-code": "residentials" } }, "surname": { "type": "string", "x-aura-field-code": "surname", "x-aura-maskable": true }, "taxOfficeId": { "type": "string", "format": "uuid", "x-aura-field-code": "taxOfficeId" }, "title": { "type": "string", "x-aura-field-code": "unlimitedCompanyCustomerTitle" }, "unlimitedCompanyCustomer": { "type": "object", "x-aura-field-code": "unlimitedCompanyCustomer" } }, "required": [ "birthDate", "citizenid", "citizenidType", "createdOrganizationId", "customerSubType", "customerType", "isPoliticallyExposed", "mainOrganizationId", "name", "onboardedOrganizationId", "surname" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 44, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "customerNumber": { "type": "string", "x-aura-field-code": "customerNumber" }, "unlimitedCompanyCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "unlimitedCompanyCustomerId" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "customerNumber": { "type": "string", "x-aura-field-code": "customerNumber" }, "unlimitedCompanyCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "unlimitedCompanyCustomerId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "customerNumber": { "type": "string", "x-aura-field-code": "customerNumber" }, "unlimitedCompanyCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "unlimitedCompanyCustomerId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-unlimited-company-customer-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "unlimited-company-customers", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/unlimited-company-customers/{id}": { "get": { "operationId": "aurax-bff-get-unlimited-company-customer-by-id", "tags": [ "unlimited-company-customers" ], "summary": "aurax-bff-get-unlimited-company-customer-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-get-unlimited-company-customer-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "unlimited-company-customers/{id}", "x-aura-request-contract": { "state": "no-members" }, "x-aura-code-response": { "state": "structure", "declared_type": "CustomerDetailDto", "payload": "CustomerDetailDto", "collection": false, "members": [ { "name": "CorporateCustomer", "declared_type": "CorporateCustomerDto", "nullable": false, "collection": false }, { "name": "UnlimitedCompanyCustomer", "declared_type": "UnlimitedCompanyCustomerDto", "nullable": false, "collection": false }, { "name": "Addresses", "declared_type": "List", "nullable": false, "collection": true }, { "name": "AddressesUI", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Emails", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Identities", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Nationalities", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Occupations", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Phones", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Residentials", "declared_type": "List", "nullable": false, "collection": true }, { "name": "ConsentItemIds", "declared_type": "List", "nullable": false, "collection": true }, { "name": "CustomerChecks", "declared_type": "List", "nullable": false, "collection": true }, { "name": "CustomerAuthorities", "declared_type": "List", "nullable": false, "collection": true }, { "name": "CustomerRelationships", "declared_type": "List", "nullable": false, "collection": true }, { "name": "CustomerTaxpayers", "declared_type": "List", "nullable": false, "collection": true }, { "name": "CustomerAttributes", "declared_type": "List", "nullable": false, "collection": true }, { "name": "CustomerRepresentativeAssignments", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." } }, "put": { "operationId": "aurax-bff-redirect-edit-unlimited-company-customer-ui-bpm", "tags": [ "unlimited-company-customers" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-edit-unlimited-company-customer-ui-bpm", "description": "Request and response fields are declared on the routing target `edit-unlimited-company-customer-ui-bpm`; this entry declares none of its own.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in this route template but not among the Route-bound fields of the routing target `edit-unlimited-company-customer-ui-bpm`, whose own path is decoupled from this one.", "x-aura-source": "route-template-only-after-collapse" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "addressFields": { "type": "array", "items": { "type": "object", "properties": { "fieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "addressTypeFieldId" }, "fieldValue": { "type": "string", "x-aura-field-code": "addressTypeFieldValue" } }, "required": [ "fieldId", "fieldValue" ], "x-aura-field-code": "addressFields" } }, "addressId": { "type": "string", "format": "uuid", "x-aura-field-code": "addressId" }, "addressName": { "type": "string", "x-aura-field-code": "addressName" }, "addressType": { "type": "integer", "format": "int32", "x-aura-field-code": "addressType" }, "addressTypeId": { "type": "string", "format": "uuid", "x-aura-field-code": "addressTypeId" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" } }, "required": [ "_rowStatus", "addressFields", "addressType", "addressTypeId", "isContact", "isDefault" ], "x-aura-field-code": "addresses" } }, "birthCountryId": { "type": "integer", "format": "int32", "x-aura-field-code": "birthCountryId" }, "birthDate": { "type": "string", "format": "date", "x-aura-field-code": "birthDate" }, "birthPlace": { "type": "string", "x-aura-field-code": "birthPlace" }, "changeStatus": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "closedReason": { "type": "integer", "format": "int32", "x-aura-field-code": "closedReason" }, "customerStatus": { "type": "string", "format": "date", "x-aura-field-code": "closedDate" } }, "required": [ "_rowStatus" ], "x-aura-field-code": "changeStatus" } }, "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "citizenidType": { "type": "integer", "format": "int32", "x-aura-field-code": "citizenidType" }, "closedDate": { "type": "string", "format": "date", "x-aura-field-code": "closedDate" }, "consentItemIds": { "type": "array", "items": { "type": "string", "x-aura-field-code": "consentItemIds" } }, "createdOrganizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "createdOrganizationId" }, "customerSubType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerSubType" }, "customerTaxpayers": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "countryId": { "type": "integer", "format": "int32", "x-aura-field-code": "countryId" }, "description": { "type": "string", "x-aura-field-code": "description" }, "taxNumber": { "type": "string", "x-aura-field-code": "taxNumber" }, "taxpayerId": { "type": "string", "format": "uuid", "x-aura-field-code": "taxpayerId" }, "taxpayerType": { "type": "integer", "format": "int32", "x-aura-field-code": "taxpayerType" } }, "required": [ "_rowStatus", "countryId", "taxNumber", "taxpayerType" ], "x-aura-field-code": "customerTaxpayers" } }, "customerType": { "type": "integer", "format": "int32", "x-aura-field-code": "customerType" }, "deathDate": { "type": "string", "format": "date", "x-aura-field-code": "deathDate" }, "emails": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "email": { "type": "string", "x-aura-field-code": "email" }, "emailId": { "type": "string", "format": "uuid", "x-aura-field-code": "emailId" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "isVerified": { "type": "boolean", "x-aura-field-code": "isVerified" }, "mailId": { "type": "string", "format": "uuid", "x-aura-field-code": "mailId" } }, "required": [ "_rowStatus", "email", "isContact", "isDefault" ], "x-aura-field-code": "emails" } }, "establishedDate": { "type": "string", "format": "date", "x-aura-field-code": "establishedDate" }, "fatherName": { "type": "string", "x-aura-field-code": "fatherName" }, "fullName": { "type": "string", "x-aura-field-code": "fullName" }, "gender": { "type": "integer", "format": "int32", "x-aura-field-code": "gender" }, "givenName": { "type": "string", "x-aura-field-code": "givenName" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "identities": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "identityCardId": { "type": "string", "format": "uuid", "x-aura-field-code": "identityCardId" }, "identityFields": { "type": "array", "items": { "type": "object", "properties": { "fieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "identityTypeFieldId" }, "fieldValue": { "type": "string", "x-aura-field-code": "identityTypeFieldValue" } }, "required": [ "fieldId", "fieldValue" ], "x-aura-field-code": "identityTypeFields" } }, "identityTypeId": { "type": "string", "format": "uuid", "x-aura-field-code": "identityTypeId" } }, "required": [ "_rowStatus", "identityFields", "identityTypeId" ], "x-aura-field-code": "identities" } }, "individualCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "individualCustomerId" }, "isPoliticallyExposed": { "type": "boolean", "x-aura-field-code": "isPoliticallyExposed" }, "maidenSurname": { "type": "string", "x-aura-field-code": "maidenSurname" }, "mainOrganizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "mainOrganizationId" }, "maritalStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "maritalStatus" }, "middleName": { "type": "string", "x-aura-field-code": "middleName" }, "motherMaidenSurname": { "type": "string", "x-aura-field-code": "motherMaidenSurname" }, "motherName": { "type": "string", "x-aura-field-code": "motherName" }, "name": { "type": "string", "x-aura-field-code": "firstName" }, "nationalities": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "countryId": { "type": "integer", "format": "int32", "x-aura-field-code": "countryId" }, "nationalityId": { "type": "string", "format": "uuid", "x-aura-field-code": "nationalityId" }, "priority": { "type": "integer", "format": "int32", "x-aura-field-code": "priority" } }, "required": [ "_rowStatus", "countryId", "priority" ], "x-aura-field-code": "nationalities" } }, "occupations": { "type": "array", "items": { "type": "object", "properties": { "fieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "occupationTypeFieldId" }, "typeId": { "type": "string", "format": "uuid", "x-aura-field-code": "occupationTypeId" } }, "required": [ "fieldId", "typeId" ], "x-aura-field-code": "occupations" } }, "onboardedOrganizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "onboardedOrganizationId" }, "phones": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "isContact": { "type": "boolean", "x-aura-field-code": "isContact" }, "isDefault": { "type": "boolean", "x-aura-field-code": "isDefault" }, "phoneId": { "type": "string", "format": "uuid", "x-aura-field-code": "phoneId" }, "phoneNumber": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true }, "phoneType": { "type": "integer", "format": "int32", "x-aura-field-code": "phoneType" } }, "required": [ "_rowStatus", "isContact", "isDefault", "phoneNumber", "phoneType" ], "x-aura-field-code": "phones" } }, "profiles": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "customerProfileId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerProfileId" }, "profile": { "type": "integer", "format": "int32", "x-aura-field-code": "profile" } }, "x-aura-field-code": "profiles" } }, "relations": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "_rowStatus" }, "description": { "type": "string", "x-aura-field-code": "authorityDescription" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "customerRelationshipId" }, "relationType": { "type": "integer", "format": "int32", "x-aura-field-code": "relationType" }, "startDate": { "type": "string", "format": "date-time", "x-aura-field-code": "startDate" }, "toCitizenid": { "type": "string", "x-aura-field-code": "toCitizenid" }, "toCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "toCustomerId" } }, "x-aura-field-code": "relations" } }, "residency": { "type": "integer", "format": "int32", "x-aura-field-code": "residency" }, "residentials": { "type": "array", "items": { "type": "object", "properties": { "_rowStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "rowStatus" }, "countryId": { "type": "integer", "format": "int32", "x-aura-field-code": "countryId" }, "priority": { "type": "integer", "format": "int32", "x-aura-field-code": "priority" }, "residentialId": { "type": "string", "format": "uuid", "x-aura-field-code": "residentialId" } }, "required": [ "_rowStatus", "countryId", "priority" ], "x-aura-field-code": "residentials" } }, "surname": { "type": "string", "x-aura-field-code": "surname", "x-aura-maskable": true }, "taxNo": { "type": "string", "x-aura-field-code": "taxNo" }, "taxOfficeId": { "type": "string", "format": "uuid", "x-aura-field-code": "taxOfficeId" }, "title": { "type": "string", "x-aura-field-code": "unlimitedCompanyCustomerTitle" }, "unlimitedCompanyCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "unlimitedCompanyCustomerId" } }, "required": [ "birthDate", "changeStatus", "citizenid", "citizenidType", "createdOrganizationId", "customerSubType", "customerType", "id", "individualCustomerId", "isPoliticallyExposed", "mainOrganizationId", "name", "onboardedOrganizationId", "surname", "unlimitedCompanyCustomerId" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 44, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-edit-unlimited-company-customer-ui-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "unlimited-company-customers/{id}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/update-denomination-bpmn": { "put": { "operationId": "aurax-bff-redirect-update-denomination-bpmn", "tags": [ "update-denomination-bpmn" ], "summary": "aurax-bff-redirect-update-denomination-bpmn", "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-denomination-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "update-denomination-bpmn", "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/update-eledger-request-bpmn": { "put": { "operationId": "aurax-bff-redirect-update-eledger-request-bpmn", "tags": [ "update-eledger-request-bpmn" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-update-eledger-request-bpmn", "description": "Request and response fields are declared on the routing target `update-eledger-request-bpmn`; this entry declares none of its own.\n\nDeclared as Route-bound but absent from the route template, so not sendable: id.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "beginDate": { "type": "string", "format": "date", "x-aura-field-code": "eledgerRequestBeginDate" }, "description": { "type": "string", "x-aura-field-code": "eledgerRequestDescription" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "eledgerRequestEndDate" }, "fileFormat": { "type": "integer", "format": "int32", "x-aura-field-code": "fileFormat" }, "fileName": { "type": "string", "x-aura-field-code": "fileName" }, "lastEntryNumber": { "type": "string", "x-aura-field-code": "lastEntryNumber" }, "lastLineNumber": { "type": "string", "x-aura-field-code": "lastLineNumber" } } } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 7, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-eledger-request-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "update-eledger-request-bpmn", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/update-eledger-request-status-bpmn": { "put": { "operationId": "aurax-bff-redirect-update-eledger-request-status-bpmn", "tags": [ "update-eledger-request-status-bpmn" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-update-eledger-request-status-bpmn", "description": "Request and response fields are declared on the routing target `update-eledger-request-status-bpmn`; this entry declares none of its own.\n\nDeclared as Route-bound but absent from the route template, so not sendable: id.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "format": "int32", "x-aura-field-code": "eledgerRequestStatus" } }, "required": [ "status" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-eledger-request-status-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "update-eledger-request-status-bpmn", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/update-price-rate-sync-process-bpmn": { "post": { "operationId": "aurax-bff-redirect-update-price-rate-sync-process-bpmn", "tags": [ "update-price-rate-sync-process-bpmn" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-update-price-rate-sync-process-bpmn", "description": "Request and response fields are declared on the routing target `update-price-rate-sync-process-bpmn`; this entry declares none of its own.\n\nDeclared as Route-bound but absent from the route template, so not sendable: id.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "channelType": { "type": "integer", "format": "int32", "x-aura-field-code": "channelType" }, "currencyId": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyId" }, "defaultRate": { "type": "number", "format": "decimal", "x-aura-field-code": "defaultRate" }, "domainType": { "type": "integer", "format": "int32", "x-aura-field-code": "domainTypePr" }, "maturity": { "type": "integer", "format": "int32", "x-aura-field-code": "maturity" }, "maxRate": { "type": "number", "format": "decimal", "x-aura-field-code": "maxRate" }, "minRate": { "type": "number", "format": "decimal", "x-aura-field-code": "minRate" }, "productType": { "type": "integer", "format": "int32", "x-aura-field-code": "productType" } }, "required": [ "channelType", "currencyId", "defaultRate", "domainType", "maturity", "maxRate", "minRate", "productType" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 8, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-price-rate-sync-process-bpmn", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "update-price-rate-sync-process-bpmn", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/user-devices": { "get": { "operationId": "aurax-bff-redirect-get-user-device-list", "tags": [ "user-devices" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-user-device-list", "description": "Request and response fields are declared on the routing target `get-user-device-list`; this entry declares none of its own.", "parameters": [ { "name": "searchCustomerId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "searchCustomerId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 1 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "deviceModel": { "type": "string", "x-aura-field-code": "deviceModel" }, "deviceOsVersion": { "type": "string", "x-aura-field-code": "deviceOsVersion" }, "deviceStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "deviceStatus" }, "deviceToken": { "type": "string", "x-aura-field-code": "deviceToken" }, "isRooted": { "type": "boolean", "x-aura-field-code": "isRooted" }, "lastLoginDate": { "type": "string", "format": "date-time", "x-aura-field-code": "lastLoginDate" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-user-device-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "user-devices", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-user-device-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "SearchCustomerId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "`PwfUserDeviceModel` is not among the C# declarations parsed from this repository. The resolver checks this repository first, then permits a lookup in `aura/framework` or `aura/kernel` only when this repository declares the matching 0.2-line PackageReference. This unresolved verdict means neither licensed lookup produced exactly one parsed declaration. The view does not expose whether that was because no eligible package proof exists or because the entitled platform source does not declare the name, so this page does not guess between them. It is a dependency-boundary gap in what this portal can resolve, not evidence that the service returns no body.", "declared_type": "List", "envelopes": [ "List" ], "payload": "PwfUserDeviceModel" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_INTGRTN_70", "status": 400, "message": null, "message_available": false, "constant_name": "PWF_BCK_ERROR" } ] } } }, "/user-devices/by-token": { "delete": { "operationId": "aurax-bff-redirect-delete-device", "tags": [ "user-devices" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-delete-device", "description": "Request and response fields are declared on the routing target `delete-device`; this entry declares none of its own.", "parameters": [ { "name": "deviceToken", "in": "query", "required": true, "schema": { "type": "string", "x-aura-field-code": "deviceToken" } } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 1 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-device", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "user-devices/by-token", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "DeviceToken", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "PwfResponseDto", "payload": "PwfResponseDto", "collection": false, "members": [ { "name": "VerificationSignature", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SecretKey", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CipherText", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Content", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_INTGRTN_70", "status": 400, "message": null, "message_available": false, "constant_name": "PWF_BCK_ERROR" } ] } }, "get": { "operationId": "aurax-bff-redirect-get-user-device-info-by-device-token", "tags": [ "user-devices" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-user-device-info-by-device-token", "description": "Request and response fields are declared on the routing target `get-user-device-info-by-device-token`; this entry declares none of its own.", "parameters": [ { "name": "deviceToken", "in": "query", "required": true, "schema": { "type": "string", "x-aura-field-code": "deviceToken" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 1 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceModel": { "type": "string", "x-aura-field-code": "deviceModel" }, "deviceOsVersion": { "type": "string", "x-aura-field-code": "deviceOsVersion" }, "deviceStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "deviceStatus" }, "deviceToken": { "type": "string", "x-aura-field-code": "deviceToken" }, "isRooted": { "type": "boolean", "x-aura-field-code": "isRooted" }, "lastLoginDate": { "type": "string", "format": "date-time", "x-aura-field-code": "lastLoginDate" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-user-device-info-by-device-token", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "user-devices/by-token", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "DeviceToken", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "PwfDeviceInfoDto", "payload": "PwfDeviceInfoDto", "collection": false, "members": [ { "name": "LastLoginDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "DeviceToken", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DeviceModel", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DeviceOsVersion", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsRooted", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "DeviceStatus", "declared_type": "int", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_INTGRTN_70", "status": 400, "message": null, "message_available": false, "constant_name": "PWF_BCK_ERROR" } ] } } }, "/user-devices/lock": { "post": { "operationId": "aurax-bff-redirect-lock-device-by-device-token", "tags": [ "user-devices" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-lock-device-by-device-token", "description": "Request and response fields are declared on the routing target `lock-device-by-device-token`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceToken": { "type": "string", "x-aura-field-code": "deviceToken" } }, "required": [ "deviceToken" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-lock-device-by-device-token", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "user-devices/lock", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "DeviceToken", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "PwfResponseDto", "payload": "PwfResponseDto", "collection": false, "members": [ { "name": "VerificationSignature", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SecretKey", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CipherText", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Content", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_INTGRTN_70", "status": 400, "message": null, "message_available": false, "constant_name": "PWF_BCK_ERROR" } ] } } }, "/user-devices/unlock": { "post": { "operationId": "aurax-bff-redirect-unlock-device-by-device-token", "tags": [ "user-devices" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-unlock-device-by-device-token", "description": "Request and response fields are declared on the routing target `unlock-device-by-device-token`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceToken": { "type": "string", "x-aura-field-code": "deviceToken" } }, "required": [ "deviceToken" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-unlock-device-by-device-token", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "user-devices/unlock", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "DeviceToken", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "PwfResponseDto", "payload": "PwfResponseDto", "collection": false, "members": [ { "name": "VerificationSignature", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SecretKey", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CipherText", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Content", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_INTGRTN_70", "status": 400, "message": null, "message_available": false, "constant_name": "PWF_BCK_ERROR" } ] } } }, "/user-favorites": { "get": { "operationId": "aurax-bff-redirect-get-user-favorite-list", "tags": [ "user-favorites" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-user-favorite-list", "description": "Request and response fields are declared on the routing target `get-user-favorite-list`; this entry declares none of its own.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "code" }, "expression": { "type": "string", "x-aura-field-code": "expression" }, "parameters": { "type": "object", "x-aura-field-code": "user_favorite_parameters" } }, "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } }, { "name": "withAuthorization", "in": "query", "required": false, "schema": { "type": "boolean", "x-aura-field-code": "auraxManagemenetWithAuthorization" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 6 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a collection.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-user-favorite-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "user-favorites", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-user-favorite-list`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false }, { "name": "WithAuthorization", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "UserFavoriteDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "FormDefinitionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "FormName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UrlPath", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ARXMNGMNT_5", "status": 400, "message": { "ar": "خطأ في خدمة تفويض Keycloak.", "en": "Keycloak authorization service error.", "tr": "Keycloak yetkilendirme servisi hatası." }, "message_available": true, "constant_name": "KEYCLOAK_AUTHORIZATION_SERVICE_ERROR" } ] } }, "post": { "operationId": "aurax-bff-redirect-create-user-favorite", "tags": [ "user-favorites" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-create-user-favorite", "description": "Request and response fields are declared on the routing target `create-user-favorite`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "formDefinitionId": { "type": "string", "format": "uuid", "x-aura-field-code": "formDefinitionId" } }, "required": [ "formDefinitionId" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-user-favorite", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "user-favorites", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "FormDefinitionId", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "AuraCommandDto", "payload": "AuraCommandDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ARXMNGMNT_1", "status": 400, "message": { "ar": "تمت إضافة الشاشة بالفعل إلى المفضلة.", "en": "Screen already added to favorites.", "tr": "Ekran favorilere zaten eklenmiş." }, "message_available": true, "constant_name": "USER_FAVORITE_ALREADY_ADDED" }, { "code": "ERR_ARXMNGMNT_2", "status": 400, "message": { "ar": "يمكن أن يكون العدد الإجمالي للمفضلات {0} كحد أقصى.", "en": "Total number of favorites can be at most {0}.", "tr": "Toplam favori sayısı en fazla {0} olabilir." }, "message_available": true, "constant_name": "USER_FAVORITE_COUNT_CANNOT_MORE_LIMIT" } ] } } }, "/user-favorites/by-form-definition-id/{formDefinitionId}": { "delete": { "operationId": "aurax-bff-redirect-delete-user-favorite", "tags": [ "user-favorites" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-delete-user-favorite", "description": "Request and response fields are declared on the routing target `delete-user-favorite`; this entry declares none of its own.", "parameters": [ { "name": "formDefinitionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "formDefinitionId" } } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-user-favorite", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "user-favorites/by-form-definition-id/{formDefinitionId}", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "FormDefinitionId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ARXMNGMNT_3", "status": 400, "message": { "ar": "لم يتم العثور على المفضلة الخاصة بالمستخدم.", "en": "User favorite not found.", "tr": "Kullanıcı favorisi bulunamadı." }, "message_available": true, "constant_name": "USER_FAVORITE_NOT_FOUND" } ] } } }, "/user-notifications": { "get": { "operationId": "aurax-bff-redirect-get-user-notification-list", "tags": [ "user-notifications" ], "summary": "aurax-bff-redirect-get-user-notification-list", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "lastDayCount": { "type": "integer", "format": "int32", "x-aura-field-code": "lastDayCount" } } } } }, "description": "The catalog declares Body-bound fields on this GET operation. Request bodies on GET have no defined semantics in HTTP; this documents the catalog, not a recommendation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": false, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "This usage type is outside the invocation layer's filtered set, so that layer applies no binding-source filter at all and every declared source is passed through.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-user-notification-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "user-notifications", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "LastDayCount", "declared_type": null, "nullable": true, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "UserNotificationDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "GroupName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "NotificationType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Message", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MessageParameters", "declared_type": "Dictionary", "nullable": false, "collection": false }, { "name": "IsRead", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "CreatedDate", "declared_type": "DateTime", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-user-notification-list", "target_dapr_app_id": "aurax-management-service", "target_route": "user-notifications", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/user-tasks": { "get": { "operationId": "aurax-bff-redirect-get-user-task-list", "tags": [ "user-tasks" ], "summary": "aurax-bff-redirect-get-user-task-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-user-task-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "user-tasks", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "UserTaskDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ElementId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BpmnProcessId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ProcessDefinitionId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "FormDefinitionId", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-user-task-list", "target_dapr_app_id": "bpm-service", "target_route": "user-tasks", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/user-tasks/inbox/by-workflow-pool/{isWorkflowPool}": { "get": { "operationId": "aurax-bff-get-inbox-item-list", "tags": [ "user-tasks" ], "summary": "aurax-bff-get-inbox-item-list", "parameters": [ { "name": "isWorkflowPool", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-get-inbox-item-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "user-tasks/inbox/by-workflow-pool/{isWorkflowPool}", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "InboxItemListDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "StartDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "StepStartDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "FormId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "StarterUserCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "StarterOrganizationName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ProcessName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "StepName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ProcessInstanceKey", "declared_type": "long", "nullable": false, "collection": false }, { "name": "ProcessDefinitionId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "BpmnProcessId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ProcessPriority", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ProcessUserTaskTranslations", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-inbox-item-list", "target_dapr_app_id": "bpm-service", "target_route": "user-tasks/inbox", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/user-tasks/outbox": { "get": { "operationId": "aurax-bff-get-outbox-item-list", "tags": [ "user-tasks" ], "summary": "aurax-bff-get-outbox-item-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-get-outbox-item-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "user-tasks/outbox", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "GetOutboxItemListDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "StartDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "TransactionDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "FormId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ProcessName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "StepName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "StepStartDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "ApprovalStatus", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ProcessInstanceKey", "declared_type": "long", "nullable": false, "collection": false }, { "name": "ProcessInstanceId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "BpmnProcessId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ProcessDefinitionId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "StarterUserCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InstanceState", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-outbox-item-list", "target_dapr_app_id": "bpm-service", "target_route": "user-tasks/outbox", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } } }, "/user-tasks/{id}/assign": { "put": { "operationId": "aurax-bff-redirect-update-user-task-status", "tags": [ "user-tasks" ], "summary": "aurax-bff-redirect-update-user-task-status", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-user-task-status", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "user-tasks/{id}/assign", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "AssignCode", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "forwarded": { "service_code": "update-user-task-status", "target_dapr_app_id": "bpm-service", "target_route": "user-tasks/{id}/assign", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_BPM_25", "status": 400, "message": { "ar": "تم تخصيص هذا السجل لشخص آخر.", "en": "This record has been assigned to someone else.", "tr": "Bu kayıt başka birine atanmıştır." }, "message_available": true, "constant_name": "TASK_ALREADY_ASSIGNED" }, { "code": "ERR_BPM_30", "status": 400, "message": { "ar": "لم يتم العثور على المهمة.", "en": "Task cannot be found.", "tr": "Görev bulunamadı." }, "message_available": true, "constant_name": "TASK_NOT_FOUND" }, { "code": "ERR_BPM_48", "status": 400, "message": { "ar": "لا يمكن تحديث معلومات الموظف المعين لهذا السجل.", "en": "This record's assigned personnel information cannot be updated.", "tr": "Bu kaydın atanan kişi bilgileri güncellenemez." }, "message_available": true, "constant_name": "TASK_STATUS_NOT_VALID" } ] } } }, "/user-tasks/{id}/complete": { "post": { "operationId": "aurax-bff-redirect-complete-user-task", "tags": [ "user-tasks" ], "summary": "aurax-bff-redirect-complete-user-task", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-complete-user-task", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "user-tasks/{id}/complete", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "ApprovalStatus", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "Variables", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "forwarded": { "service_code": "complete-user-task", "target_dapr_app_id": "bpm-service", "target_route": "user-tasks/{id}/complete", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_BPM_27", "status": 400, "message": { "ar": "تم تعيين هذه المهمة لمستخدم آخر.", "en": "This task is assigned to another user.", "tr": "Bu görev başka bir kullanıcıya atanır." }, "message_available": true, "constant_name": "TASK_ASSIGNED_ANOTHER_USER" }, { "code": "ERR_BPM_49", "status": 400, "message": null, "message_available": false, "constant_name": "USER_TASK_NOT_EXISTS" }, { "code": "ERR_BPM_50", "status": 400, "message": null, "message_available": false, "constant_name": "JOB_NOT_FOUND_FOR_THIS_PROCESS_ELEMENT_INSTANCE_KEY" }, { "code": "ERR_BPM_51", "status": 400, "message": null, "message_available": false, "constant_name": "MULTIPLE_JOB_FOUND_FOR_THIS_PROCESS_ELEMENT_INSTANCE_KEY" } ] } } }, "/user-tasks/{id}/details": { "get": { "operationId": "aurax-bff-redirect-get-user-task-status-detail-list", "tags": [ "user-tasks" ], "summary": "aurax-bff-redirect-get-user-task-status-detail-list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-user-task-status-detail-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "user-tasks/{id}/details", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Mode", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "GetUserTaskStatusDetailDto", "payload": "GetUserTaskStatusDetailDto", "collection": false, "members": [ { "name": "CorrelationId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ProcessInstanceKey", "declared_type": "long", "nullable": false, "collection": false }, { "name": "ProcessDefinitionKey", "declared_type": "long", "nullable": false, "collection": false }, { "name": "ProcessDefinitionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ElementInstanceKey", "declared_type": "long", "nullable": false, "collection": false }, { "name": "ElementId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ElementName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FormId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ApprovelStatus", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Mode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Variables", "declared_type": "Dictionary", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-user-task-status-detail-list", "target_dapr_app_id": "bpm-service", "target_route": "user-tasks/{id}/details", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_BPM_30", "status": 400, "message": { "ar": "لم يتم العثور على المهمة.", "en": "Task cannot be found.", "tr": "Görev bulunamadı." }, "message_available": true, "constant_name": "TASK_NOT_FOUND" } ] } } }, "/user-tasks/{id}/unassign": { "put": { "operationId": "aurax-bff-redirect-update-user-task-status-unassign", "tags": [ "user-tasks" ], "summary": "aurax-bff-redirect-update-user-task-status-unassign", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-user-task-status-unassign", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "user-tasks/{id}/unassign", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "forwarded": { "service_code": "update-user-task-status-unassign", "target_dapr_app_id": "bpm-service", "target_route": "user-tasks/{id}/unassign", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_BPM_30", "status": 400, "message": { "ar": "لم يتم العثور على المهمة.", "en": "Task cannot be found.", "tr": "Görev bulunamadı." }, "message_available": true, "constant_name": "TASK_NOT_FOUND" }, { "code": "ERR_BPM_48", "status": 400, "message": { "ar": "لا يمكن تحديث معلومات الموظف المعين لهذا السجل.", "en": "This record's assigned personnel information cannot be updated.", "tr": "Bu kaydın atanan kişi bilgileri güncellenemez." }, "message_available": true, "constant_name": "TASK_STATUS_NOT_VALID" } ] } } }, "/user-tasks/{id}/variables": { "get": { "operationId": "aurax-bff-redirect-get-user-task-status-variables-by-id", "tags": [ "user-tasks" ], "summary": "aurax-bff-redirect-get-user-task-status-variables-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-user-task-status-variables-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "user-tasks/{id}/variables", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "no-members", "note": "`GetUserTaskStatusVariablesByIdDto` was parsed from this repository but the parse found no members on it. An empty declaration and a parse that missed them look the same from here, so this page asserts neither.", "declared_type": "GetUserTaskStatusVariablesByIdDto", "payload": "GetUserTaskStatusVariablesByIdDto", "forwarded": { "service_code": "get-user-task-status-variables-by-id", "target_dapr_app_id": "bpm-service", "target_route": "user-tasks/{id}/variables", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_BPM_30", "status": 400, "message": { "ar": "لم يتم العثور على المهمة.", "en": "Task cannot be found.", "tr": "Görev bulunamadı." }, "message_available": true, "constant_name": "TASK_NOT_FOUND" } ] } } }, "/users": { "get": { "operationId": "aurax-bff-redirect-get-user-list", "tags": [ "users" ], "summary": "aurax-bff-redirect-get-user-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-user-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "users", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "Q", "declared_type": null, "nullable": false, "collection": false }, { "name": "UserName", "declared_type": null, "nullable": false, "collection": false }, { "name": "Search", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "PagedResultDto", "envelopes": [ "PagedResultDto" ], "payload": "GetUserListDto", "collection": false, "members": [ { "name": "Id", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CreatedTimestamp", "declared_type": "long", "nullable": false, "collection": false }, { "name": "UserName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Enabled", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "Totp", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "EmailVerified", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "FirstName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LastName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Email", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Attributes", "declared_type": "Attributes", "nullable": false, "collection": false }, { "name": "NotBefore", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Access", "declared_type": "Access", "nullable": false, "collection": false }, { "name": "DisableableCredentialTypes", "declared_type": "List", "nullable": false, "collection": true }, { "name": "RequiredActions", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." } }, "post": { "operationId": "aurax-bff-redirect-create-user-bpm", "tags": [ "users" ], "summary": "aurax-bff-redirect-create-user-bpm", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-user-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "users", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/users/authorities": { "post": { "operationId": "aurax-bff-redirect-authorization-check-resource-by-realm", "tags": [ "users" ], "summary": "aurax-bff-redirect-authorization-check-resource-by-realm", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-authorization-check-resource-by-realm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "users/authorities", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/users/current": { "get": { "operationId": "aurax-bff-get-current-user", "tags": [ "users" ], "summary": "aurax-bff-get-current-user", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-get-current-user", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "users/current", "x-aura-request-contract": { "state": "no-members" }, "x-aura-code-response": { "state": "unresolved", "note": "The repository declares `UserDto` 4 times and nothing in the route expression says which one. No structure is published rather than one picked at random.", "declared_type": "UserDto", "payload": "UserDto" } } }, "/users/current/detail": { "get": { "operationId": "aurax-bff-get-current-user-detail", "tags": [ "users" ], "summary": "aurax-bff-get-current-user-detail", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-get-current-user-detail", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "users/current/detail", "x-aura-request-contract": { "state": "no-members" }, "x-aura-code-response": { "state": "structure", "declared_type": "CurrentUserDetailDto", "payload": "CurrentUserDetailDto", "collection": false, "members": [ { "name": "UserId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "SessionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "IsLdapUser", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "PhoneNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LastDateToChangePassword", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Email", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/users/forget-password": { "post": { "operationId": "aurax-bff-dynamic-forget-password-send-otp", "tags": [ "users" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-forget-password-send-otp", "description": "Request and response fields are declared on the routing target `send-otp-forget-password`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userIdentifier": { "type": "string", "x-aura-field-code": "userIdentifier" } }, "required": [ "userIdentifier" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-forget-password-send-otp", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "users/forget-password", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "structure", "declared_type": "SendotpForgetPasswordResponse", "payload": "SendotpForgetPasswordResponse", "collection": false, "members": [ { "name": "Username", "declared_type": "string", "nullable": false, "collection": false }, { "name": "EndDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "TransactionId", "declared_type": "Guid", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_BPMCUS_17", "status": 400, "message": null, "message_available": false, "constant_name": null }, { "code": "ERR_CORE_161", "status": 400, "message": null, "message_available": false, "constant_name": null } ] } } }, "/users/forget-password-verify": { "post": { "operationId": "aurax-bff-dynamic-forget-password-verify-otp-and-reset-password", "tags": [ "users" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-dynamic-forget-password-verify-otp-and-reset-password", "description": "Request and response fields are declared on the routing target `forget-password-verify-otp-and-reset-password`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "oneTimePassword": { "type": "string", "x-aura-field-code": "oneTimePassword", "x-aura-encrypted": true }, "transactionId": { "type": "string", "format": "uuid", "x-aura-field-code": "transactionId" }, "username": { "type": "string", "x-aura-field-code": "username" } }, "required": [ "oneTimePassword", "transactionId", "username" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 3, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-dynamic-forget-password-verify-otp-and-reset-password", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "users/forget-password-verify", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/users/password/change": { "put": { "operationId": "aurax-bff-redirect-change-user-password-bpm", "tags": [ "users" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-change-user-password-bpm", "description": "Request and response fields are declared on the routing target `change-user-password-bpm`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "newPassword": { "type": "string", "x-aura-field-code": "newPassword", "x-aura-encrypted": true }, "oldPassword": { "type": "string", "x-aura-field-code": "oldPassword", "x-aura-encrypted": true }, "username": { "type": "string", "x-aura-field-code": "keycloakUserName" }, "validityDuration": { "type": "integer", "format": "int32", "x-aura-field-code": "validityDuration" } }, "required": [ "newPassword", "oldPassword", "username", "validityDuration" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 4, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-change-user-password-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "users/password/change", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/users/{userId}": { "delete": { "operationId": "aurax-bff-redirect-delete-user-bpm", "tags": [ "users" ], "summary": "aurax-bff-redirect-delete-user-bpm", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-user-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "users/{userId}", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "get": { "operationId": "aurax-bff-redirect-get-user-by-id", "tags": [ "users" ], "summary": "aurax-bff-redirect-get-user-by-id", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-user-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "users/{userId}", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "put": { "operationId": "aurax-bff-redirect-update-user-bpm", "tags": [ "users" ], "summary": "aurax-bff-redirect-update-user-bpm", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-user-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "users/{userId}", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/users/{userId}/attributes": { "put": { "operationId": "aurax-bff-redirect-partial-update-user-attributes-partial-bpm", "tags": [ "users" ], "summary": "aurax-bff-redirect-partial-update-user-attributes-partial-bpm", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-partial-update-user-attributes-partial-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "users/{userId}/attributes", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/users/{userId}/groups": { "get": { "operationId": "aurax-bff-redirect-get-group-assigned-to-user", "tags": [ "users" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-redirect-get-group-assigned-to-user", "description": "Request and response fields are declared on the routing target `get-group-assigned-to-user`; this entry declares none of its own.\n\nDeclared as Route-bound but absent from the route template, so not sendable: realm.", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "keycloakUserId" } }, { "name": "briefRepresentation", "in": "query", "required": false, "schema": { "type": "boolean", "x-aura-field-code": "briefRepresentation" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "type": "string", "x-aura-field-code": "authorization" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": false, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 1, "path": 2, "query": 1 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "This usage type is outside the invocation layer's filtered set, so that layer applies no binding-source filter at all and every declared source is passed through.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a page of records: the collection under `data`, with `total` carrying the unpaged count.", "content": { "application/json": { "schema": { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "attributes": { "type": "object", "properties": { "orgCode": { "type": "array", "items": { "type": "string", "x-aura-field-code": "orgCode" } } }, "x-aura-field-code": "attributes" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "groupId" }, "name": { "type": "string", "x-aura-field-code": "groupName" }, "path": { "type": "string", "x-aura-field-code": "keycloakGroupPath" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-group-assigned-to-user", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "users/{userId}/groups", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-capabilities": { "paging": true, "note": "Platform-provided behaviours declared on the routing target `get-group-assigned-to-user`, which is where this operation's contract lives — the same row the response shape is derived from. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/users/{userId}/role-mappings/realm": { "delete": { "operationId": "aurax-bff-redirect-remove-realm-role-from-user-bpm", "tags": [ "users" ], "summary": "aurax-bff-redirect-remove-realm-role-from-user-bpm", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-remove-realm-role-from-user-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "users/{userId}/role-mappings/realm", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "get": { "operationId": "aurax-bff-redirect-get-realm-role-to-user", "tags": [ "users" ], "summary": "aurax-bff-redirect-get-realm-role-to-user", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-realm-role-to-user", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "users/{userId}/role-mappings/realm", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } }, "post": { "operationId": "aurax-bff-redirect-assign-realm-role-to-user-bpm", "tags": [ "users" ], "summary": "aurax-bff-redirect-assign-realm-role-to-user-bpm", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-assign-realm-role-to-user-bpm", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "users/{userId}/role-mappings/realm", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/users/{userId}/role-mappings/realm/available": { "get": { "operationId": "aurax-bff-redirect-get-available-realm-level-role-to-user", "tags": [ "users" ], "summary": "aurax-bff-redirect-get-available-realm-level-role-to-user", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-available-realm-level-role-to-user", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "users/{userId}/role-mappings/realm/available", "x-aura-code-response": { "state": "unresolved", "note": "This is a gateway forwarder, not an implementation. It reads a service code from the catalog and relays the call; the framework writes no body of its own on this path. The response shape is the DOWNSTREAM target's, so it is that operation's page that can answer, and this one does not guess on its behalf." } } }, "/validations": { "get": { "operationId": "aurax-bff-redirect-get-validation-definition-list", "tags": [ "validations" ], "summary": "aurax-bff-redirect-get-validation-definition-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-validation-definition-list", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "validations", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "ValidationDefinitionDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FormulaId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "LocalizationCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsRequestStop", "declared_type": "bool?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-validation-definition-list", "target_dapr_app_id": "core-service", "target_route": "validations", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } } }, "post": { "operationId": "aurax-bff-redirect-create-validation-definition", "tags": [ "validations" ], "summary": "aurax-bff-redirect-create-validation-definition", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-create-validation-definition", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "validations", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "FormulaId", "declared_type": null, "nullable": true, "collection": false }, { "name": "LocalizationCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsRequestStop", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "command-id", "note": "The route returns `AuraCommandDto`, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, `Id`, of type `Guid`. A caller gets a JSON OBJECT with one field, not a bare value. The field is `id` on the wire.", "declared_type": "AuraCommandDto", "envelopes": [ "AuraCommandDto" ], "payload": "Guid", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false, "wire_name": "id", "wire_name_basis": "framework-naming-policy" } ], "naming": "Member names are the service's declaration names.", "synthesized": true, "forwarded": { "service_code": "create-validation-definition", "target_dapr_app_id": "core-service", "target_route": "validations", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_CORE_101", "status": 400, "message": { "ar": "توجد بالفعل عملية تحقق بهذا الرمز.", "en": "There is already a validation with this code.", "tr": "Bu kodla zaten bir doğrulama var." }, "message_available": true, "constant_name": "THERE_IS_ALREADY_A_VALIDATION_WITH_THIS_NAME" }, { "code": "ERR_CORE_70", "status": 400, "message": { "ar": "معرف الصيغة غير موجود.", "en": "Formula cannot be found.", "tr": "Formül bulunamadı." }, "message_available": true, "constant_name": "FORMULA_DEFINITION_ID_IS_NOT_FOUND" } ] } } }, "/validations/{id}": { "delete": { "operationId": "aurax-bff-redirect-delete-validation-definition", "tags": [ "validations" ], "summary": "aurax-bff-redirect-delete-validation-definition", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-delete-validation-definition", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "validations/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "forwarded": { "service_code": "delete-validation-definition", "target_dapr_app_id": "core-service", "target_route": "validations/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_CORE_102", "status": 400, "message": { "ar": "لم يتم العثور على معرف التحقق", "en": "Validation cannot be found.", "tr": "Doğrulama bulunamadı." }, "message_available": true, "constant_name": "VALIDATION_ID_NOT_FOUND" } ] } }, "get": { "operationId": "aurax-bff-redirect-get-validation-definition-by-id", "tags": [ "validations" ], "summary": "aurax-bff-redirect-get-validation-definition-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-get-validation-definition-by-id", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "validations/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ValidationDefinitionDto", "payload": "ValidationDefinitionDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FormulaId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "LocalizationCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsRequestStop", "declared_type": "bool?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names.", "forwarded": { "service_code": "get-validation-definition-by-id", "target_dapr_app_id": "core-service", "target_route": "validations/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_CORE_102", "status": 400, "message": { "ar": "لم يتم العثور على معرف التحقق", "en": "Validation cannot be found.", "tr": "Doğrulama bulunamadı." }, "message_available": true, "constant_name": "VALIDATION_ID_NOT_FOUND" } ] } }, "put": { "operationId": "aurax-bff-redirect-update-validation-definition", "tags": [ "validations" ], "summary": "aurax-bff-redirect-update-validation-definition", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-redirect-update-validation-definition", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "validations/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "FormulaId", "declared_type": null, "nullable": false, "collection": false }, { "name": "LocalizationCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsRequestStop", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "forwarded": { "service_code": "update-validation-definition", "target_dapr_app_id": "core-service", "target_route": "validations/{id}", "link": "declared: the service code is written in the registration and is the catalog's own name for the target. The target-to-code hop is an address match." } }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_CORE_102", "status": 400, "message": { "ar": "لم يتم العثور على معرف التحقق", "en": "Validation cannot be found.", "tr": "Doğrulama bulunamadı." }, "message_available": true, "constant_name": "VALIDATION_ID_NOT_FOUND" }, { "code": "ERR_CORE_154", "status": 400, "message": { "ar": "نفس الصيغة المستخدمة تحت تعريف الخدمة", "en": "Same formula in use under the service definition.", "tr": "Aynı formül, Servis tanımı altında kullanımdadır." }, "message_available": true, "constant_name": "SERVICE_HAS_MULTIPLE_SAME_FORMULA_ERROR" }, { "code": "ERR_CORE_70", "status": 400, "message": { "ar": "معرف الصيغة غير موجود.", "en": "Formula cannot be found.", "tr": "Formül bulunamadı." }, "message_available": true, "constant_name": "FORMULA_DEFINITION_ID_IS_NOT_FOUND" } ] } } }, "/verify-customer-emlak": { "post": { "operationId": "aurax-bff-verify-customer-emlak", "tags": [ "verify-customer-emlak" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "aurax-bff-verify-customer-emlak", "description": "Request and response fields are declared on the routing target `verify-customer-emlak`; this entry declares none of its own.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "birthDate": { "type": "string", "format": "date", "x-aura-field-code": "birthDate" }, "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "phoneNumber": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true }, "queryType": { "type": "integer", "format": "int32", "x-aura-field-code": "queryType" } }, "required": [ "birthDate", "citizenid", "phoneNumber", "queryType" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 4, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "addressCountry": { "type": "string", "x-aura-field-code": "personAddressCountry" }, "addressOpenText": { "type": "string", "x-aura-field-code": "addressOpenText", "x-aura-maskable": true }, "addressType": { "type": "integer", "format": "int32", "x-aura-field-code": "addressType" }, "binder": { "type": "string", "x-aura-field-code": "binder" }, "birthPlace": { "type": "string", "x-aura-field-code": "personInfoBirthPlace" }, "building": { "type": "string", "x-aura-field-code": "building", "x-aura-maskable": true }, "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "city": { "type": "string", "x-aura-field-code": "city", "x-aura-maskable": true }, "district": { "type": "string", "x-aura-field-code": "district", "x-aura-maskable": true }, "familyRecordNo": { "type": "string", "x-aura-field-code": "familyRecordNo" }, "fatherName": { "type": "string", "x-aura-field-code": "fatherName" }, "gender": { "type": "integer", "format": "int32", "x-aura-field-code": "gender" }, "identityCardType": { "type": "integer", "format": "int32", "x-aura-field-code": "identityCardType" }, "issueDate": { "type": "string", "format": "date", "x-aura-field-code": "personInfoIssueDate" }, "issueOffice": { "type": "string", "x-aura-field-code": "identityIssueOffice" }, "issueReason": { "type": "string", "x-aura-field-code": "identityIssueReason" }, "maritalStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "maritalStatus" }, "motherName": { "type": "string", "x-aura-field-code": "motherName" }, "name": { "type": "string", "x-aura-field-code": "personInfoName", "x-aura-maskable": true }, "neighbourhood": { "type": "string", "x-aura-field-code": "neihgbourhood", "x-aura-maskable": true }, "personRecordNo": { "type": "string", "x-aura-field-code": "identityPersonRecordNo" }, "previousCitizenid": { "type": "string", "x-aura-field-code": "previousCitizenid" }, "previousSurname": { "type": "string", "x-aura-field-code": "previousSurname" }, "referenceId": { "type": "string", "x-aura-field-code": "referenceId" }, "registerCity": { "type": "string", "x-aura-field-code": "registerCity" }, "registerDistrict": { "type": "string", "x-aura-field-code": "registerDistrict", "x-aura-maskable": true }, "registrationNumber": { "type": "string", "x-aura-field-code": "registrationNumber" }, "section": { "type": "string", "x-aura-field-code": "section" }, "serialNumber": { "type": "string", "x-aura-field-code": "serialNumber" }, "spouseCitizenid": { "type": "string", "x-aura-field-code": "spouseCitizenid" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "status" }, "street": { "type": "string", "x-aura-field-code": "street", "x-aura-maskable": true }, "surname": { "type": "string", "x-aura-field-code": "surname", "x-aura-maskable": true }, "validityDate": { "type": "string", "format": "date", "x-aura-field-code": "identityValidityDate" }, "verifyResult": { "type": "boolean", "x-aura-field-code": "verifyResult" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "addressCountry": { "type": "string", "x-aura-field-code": "personAddressCountry" }, "addressOpenText": { "type": "string", "x-aura-field-code": "addressOpenText", "x-aura-maskable": true }, "addressType": { "type": "integer", "format": "int32", "x-aura-field-code": "addressType" }, "binder": { "type": "string", "x-aura-field-code": "binder" }, "birthPlace": { "type": "string", "x-aura-field-code": "personInfoBirthPlace" }, "building": { "type": "string", "x-aura-field-code": "building", "x-aura-maskable": true }, "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "city": { "type": "string", "x-aura-field-code": "city", "x-aura-maskable": true }, "district": { "type": "string", "x-aura-field-code": "district", "x-aura-maskable": true }, "familyRecordNo": { "type": "string", "x-aura-field-code": "familyRecordNo" }, "fatherName": { "type": "string", "x-aura-field-code": "fatherName" }, "gender": { "type": "integer", "format": "int32", "x-aura-field-code": "gender" }, "identityCardType": { "type": "integer", "format": "int32", "x-aura-field-code": "identityCardType" }, "issueDate": { "type": "string", "format": "date", "x-aura-field-code": "personInfoIssueDate" }, "issueOffice": { "type": "string", "x-aura-field-code": "identityIssueOffice" }, "issueReason": { "type": "string", "x-aura-field-code": "identityIssueReason" }, "maritalStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "maritalStatus" }, "motherName": { "type": "string", "x-aura-field-code": "motherName" }, "name": { "type": "string", "x-aura-field-code": "personInfoName", "x-aura-maskable": true }, "neighbourhood": { "type": "string", "x-aura-field-code": "neihgbourhood", "x-aura-maskable": true }, "personRecordNo": { "type": "string", "x-aura-field-code": "identityPersonRecordNo" }, "previousCitizenid": { "type": "string", "x-aura-field-code": "previousCitizenid" }, "previousSurname": { "type": "string", "x-aura-field-code": "previousSurname" }, "referenceId": { "type": "string", "x-aura-field-code": "referenceId" }, "registerCity": { "type": "string", "x-aura-field-code": "registerCity" }, "registerDistrict": { "type": "string", "x-aura-field-code": "registerDistrict", "x-aura-maskable": true }, "registrationNumber": { "type": "string", "x-aura-field-code": "registrationNumber" }, "section": { "type": "string", "x-aura-field-code": "section" }, "serialNumber": { "type": "string", "x-aura-field-code": "serialNumber" }, "spouseCitizenid": { "type": "string", "x-aura-field-code": "spouseCitizenid" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "status" }, "street": { "type": "string", "x-aura-field-code": "street", "x-aura-maskable": true }, "surname": { "type": "string", "x-aura-field-code": "surname", "x-aura-maskable": true }, "validityDate": { "type": "string", "format": "date", "x-aura-field-code": "identityValidityDate" }, "verifyResult": { "type": "boolean", "x-aura-field-code": "verifyResult" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "addressCountry": { "type": "string", "x-aura-field-code": "personAddressCountry" }, "addressOpenText": { "type": "string", "x-aura-field-code": "addressOpenText", "x-aura-maskable": true }, "addressType": { "type": "integer", "format": "int32", "x-aura-field-code": "addressType" }, "binder": { "type": "string", "x-aura-field-code": "binder" }, "birthPlace": { "type": "string", "x-aura-field-code": "personInfoBirthPlace" }, "building": { "type": "string", "x-aura-field-code": "building", "x-aura-maskable": true }, "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "city": { "type": "string", "x-aura-field-code": "city", "x-aura-maskable": true }, "district": { "type": "string", "x-aura-field-code": "district", "x-aura-maskable": true }, "familyRecordNo": { "type": "string", "x-aura-field-code": "familyRecordNo" }, "fatherName": { "type": "string", "x-aura-field-code": "fatherName" }, "gender": { "type": "integer", "format": "int32", "x-aura-field-code": "gender" }, "identityCardType": { "type": "integer", "format": "int32", "x-aura-field-code": "identityCardType" }, "issueDate": { "type": "string", "format": "date", "x-aura-field-code": "personInfoIssueDate" }, "issueOffice": { "type": "string", "x-aura-field-code": "identityIssueOffice" }, "issueReason": { "type": "string", "x-aura-field-code": "identityIssueReason" }, "maritalStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "maritalStatus" }, "motherName": { "type": "string", "x-aura-field-code": "motherName" }, "name": { "type": "string", "x-aura-field-code": "personInfoName", "x-aura-maskable": true }, "neighbourhood": { "type": "string", "x-aura-field-code": "neihgbourhood", "x-aura-maskable": true }, "personRecordNo": { "type": "string", "x-aura-field-code": "identityPersonRecordNo" }, "previousCitizenid": { "type": "string", "x-aura-field-code": "previousCitizenid" }, "previousSurname": { "type": "string", "x-aura-field-code": "previousSurname" }, "referenceId": { "type": "string", "x-aura-field-code": "referenceId" }, "registerCity": { "type": "string", "x-aura-field-code": "registerCity" }, "registerDistrict": { "type": "string", "x-aura-field-code": "registerDistrict", "x-aura-maskable": true }, "registrationNumber": { "type": "string", "x-aura-field-code": "registrationNumber" }, "section": { "type": "string", "x-aura-field-code": "section" }, "serialNumber": { "type": "string", "x-aura-field-code": "serialNumber" }, "spouseCitizenid": { "type": "string", "x-aura-field-code": "spouseCitizenid" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "status" }, "street": { "type": "string", "x-aura-field-code": "street", "x-aura-maskable": true }, "surname": { "type": "string", "x-aura-field-code": "surname", "x-aura-maskable": true }, "validityDate": { "type": "string", "format": "date", "x-aura-field-code": "identityValidityDate" }, "verifyResult": { "type": "boolean", "x-aura-field-code": "verifyResult" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-verify-customer-emlak", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "verify-customer-emlak", "x-aura-collapsed-from": { "note": "This operation and the target are one logical API. The path above is the caller-facing one and is deliberately decoupled from the target path." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/workflow-history/{processInstanceKey}": { "get": { "operationId": "aurax-bff-get-workflow-history", "tags": [ "workflow-history" ], "summary": "aurax-bff-get-workflow-history", "parameters": [ { "name": "processInstanceKey", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "aurax-bff-get-workflow-history", "x-aura-domain": "aurax-bff", "x-aura-raw-url-path": "workflow-history/{processInstanceKey}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "ProcessInstanceKey", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "PagedResultDto", "envelopes": [ "PagedResultDto" ], "payload": "WorkflowHistoryDto", "collection": false, "members": [ { "name": "StepName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "StepStartDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "StepEndDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "AssignCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ApprovalStatus", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AssignName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OrganizationCodes", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OrganizationName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Roles", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsWorkflow", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SubProcesses", "declared_type": "IEnumerable", "nullable": false, "collection": true }, { "name": "StepNameTranslations", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." } } } }, "x-aura-collapsed-targets": { "note": "These operations are served by this domain but are documented under the forwarder that fronts them, because a forwarder and its target are one logical API and only the caller-facing path is an address. They are listed here so an endpoint of this service is findable from this service's document.", "count": 12 }, "components": { "schemas": { "PlatformError": { "type": "object", "title": "PlatformError", "description": "The body a mapped failure returns. One `error` object; `error.code` is the only place the code appears. Not every failure carries it — see the individual statuses.", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "The platform error code. It is the identifier on the wire; a human-readable message for it is NOT guaranteed. The error catalog carries the codes seeded for this snapshot, with whichever of the published languages each one has text for, and many codes raised by services have no seeded entry at all. Where this portal knows which operations raise a code, they list it under `x-aura-error-codes`, each entry saying whether a message exists for it." }, "message": { "type": "string", "description": "The resolved message for the code, in the language the request asked for." }, "validationErrors": { "type": "array", "description": "Present on a validation failure only: one entry per rule that failed, each carrying its own code.", "items": { "type": "object", "additionalProperties": true } }, "businessErrors": { "type": "array", "description": "Present on a bulk failure only: one code/message pair per failed item.", "items": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } }, "responses": { "Error400": { "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "Error408": { "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "Error409": { "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "Error500": { "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "Error502": { "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } } } }