{ "openapi": "3.1.0", "info": { "title": "Integration Service", "version": "cbe247335bcb", "summary": "DgCore platform API surface for the Integration Service domain.", "description": "The Integration Service domain: 157 operations across 45 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}/integration-service", "description": "The full route is `https:///integration-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": "activations", "description": "Operations addressed under `/activations` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "aml", "description": "Operations addressed under `/aml` — 3 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "aml-infos", "description": "Operations addressed under `/aml-infos` — 5 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": "batch-catalog", "description": "Operations addressed under `/batch-catalog` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "card", "description": "Operations addressed under `/card` — 2 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "compensating-transactions", "description": "Operations addressed under `/compensating-transactions` — 2 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "credit-bureau-infos", "description": "Operations addressed under `/credit-bureau-infos` — 4 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "data-migrations", "description": "Operations addressed under `/data-migrations` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "dgpara-wallets", "description": "Operations addressed under `/dgpara-wallets` — 2 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "dms", "description": "Operations addressed under `/dms` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "easy-addresses", "description": "Operations addressed under `/easy-addresses` — 4 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "email-attachment-notifications", "description": "Operations addressed under `/email-attachment-notifications` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "email-multi-attachment-notifications", "description": "Operations addressed under `/email-multi-attachment-notifications` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "enqura-qualify", "description": "Operations addressed under `/enqura-qualify` — 2 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": "external-service-results", "description": "Operations addressed under `/external-service-results` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "external-services", "description": "Operations addressed under `/external-services` — 7 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` — 8 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "financier", "description": "Operations addressed under `/financier` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "fraud-transactions", "description": "Operations addressed under `/fraud-transactions` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "generate-otp", "description": "Operations addressed under `/generate-otp` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "iban-queries", "description": "Operations addressed under `/iban-queries` — 2 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "ibans", "description": "Operations addressed under `/ibans` — 2 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "identities", "description": "Operations addressed under `/identities` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "instant-payment", "description": "Operations addressed under `/instant-payment` — 3 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": "krs-risk-reports", "description": "Operations addressed under `/krs-risk-reports` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "kyc-references", "description": "Operations addressed under `/kyc-references` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "limit-assignments", "description": "Operations addressed under `/limit-assignments` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "localizations", "description": "Operations addressed under `/localizations` — 10 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "notification-providers", "description": "Operations addressed under `/notification-providers` — 14 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "parameters", "description": "Operations addressed under `/parameters` — 21 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "payfour", "description": "Operations addressed under `/payfour` — 2 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "person-address-infos", "description": "Operations addressed under `/person-address-infos` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "person-info-changes", "description": "Operations addressed under `/person-info-changes` — 3 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "person-infos", "description": "Operations addressed under `/person-infos` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "pwf-transactions", "description": "Operations addressed under `/pwf-transactions` — 2 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "rm-segments", "description": "Operations addressed under `/rm-segments` — 2 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "sms-notifications", "description": "Operations addressed under `/sms-notifications` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "verify", "description": "Operations addressed under `/verify` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "verify-login-otp", "description": "Operations addressed under `/verify-login-otp` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "virtual-iban-results", "description": "Operations addressed under `/virtual-iban-results` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "zubizu", "description": "Operations addressed under `/zubizu` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } ], "paths": { "/activations/by-customerid/{customerId}": { "put": { "operationId": "update-activation-pin-by-customer-id", "tags": [ "activations" ], "summary": "update-activation-pin-by-customer-id", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pwfCustomerId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "activationPin": { "type": "string", "x-aura-field-code": "activationPin" } }, "required": [ "activationPin" ] } } } }, "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 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": { "success": { "type": "boolean", "x-aura-field-code": "success" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "update-activation-pin-by-customer-id", "x-aura-domain": "integration", "x-aura-raw-url-path": "activations/by-customerid/{customerId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "ActivationPin", "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." } } }, "/aml-infos": { "get": { "operationId": "get-aml-info-list", "tags": [ "aml-infos" ], "summary": "get-aml-info-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" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "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": "get-aml-info-list", "x-aura-domain": "integration", "x-aura-raw-url-path": "aml-infos", "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": "AmlInfoDto", "collection": true, "members": [ { "name": "Citizenid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MatchStatus", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "RiskLevel", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "AssignedUserGuidid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TagList", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TotalRecordCount", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ReturnRecordCount", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "StartValue", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LimitValue", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ReferenceNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "NameSearchType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OutReferenceNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsWhiteList", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "WhiteListMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MinMatchRate", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "MaxMatchRate", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "BirthYear", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsSafeList", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "NationalyFilter", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsZfs", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "TotalProfileCount", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "NameSearchTypeid", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ResultInfo", "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 } }, "post": { "operationId": "create-aml-info", "tags": [ "aml-infos" ], "summary": "create-aml-info", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "assignedUserGuidid": { "type": "string", "x-aura-field-code": "assignedUserGuidid" }, "birthYear": { "type": "string", "x-aura-field-code": "birthYear" }, "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "isSafeList": { "type": "boolean", "x-aura-field-code": "isSafeList" }, "isWhiteList": { "type": "boolean", "x-aura-field-code": "isWhiteList" }, "isZfs": { "type": "boolean", "x-aura-field-code": "isZfs" }, "limitValue": { "type": "integer", "format": "int32", "x-aura-field-code": "limitValue" }, "matchStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "matchStatus", "x-aura-parameter-enumeration": { "state": "resolved", "parameter": "match_status", "values": [ { "value": 0, "name": "No Match", "labels": { "en": "No Match", "tr": "Eşleşme Yok", "ar": "لا تطابق" } }, { "value": 1, "name": "Potential Match", "labels": { "en": "Potential Match", "tr": "Potansiyel Eşleşme", "ar": "مطابقة محتملة" } }, { "value": 2, "name": "False Positive", "labels": { "en": "False Positive", "tr": "Yanlış Pozitif", "ar": "إيجابي كاذب" } }, { "value": 3, "name": "Corporate", "labels": { "en": "Corporate", "tr": "Kurumsal", "ar": "شركة" } }, { "value": 4, "name": "True Positive", "labels": { "en": "True Positive", "tr": "Doğru Pozitif", "ar": "إيجابي حقيقي" } }, { "value": 5, "name": "True Positive Approve", "labels": { "en": "True Positive Approve", "tr": "Gerçek Pozitif Onayla", "ar": "إيجابي صحيح موافق" } }, { "value": 6, "name": "True Positive Reject", "labels": { "en": "True Positive Reject", "tr": "Gerçek Pozitif Reddet", "ar": "رفض الإيجابيات الحقيقية" } } ] } }, "maxMatchRate": { "type": "integer", "format": "int32", "x-aura-field-code": "maxMatchRate" }, "minMatchRate": { "type": "integer", "format": "int32", "x-aura-field-code": "minMatchRate" }, "nameSearchType": { "type": "string", "x-aura-field-code": "nameSearchType" }, "nameSearchTypeid": { "type": "integer", "format": "int32", "x-aura-field-code": "nameSearchTypeid" }, "nationalyFilter": { "type": "string", "x-aura-field-code": "nationalyFilter" }, "outReferenceNumber": { "type": "string", "x-aura-field-code": "outReferenceNumber" }, "referenceNumber": { "type": "string", "x-aura-field-code": "referenceNumber" }, "resultInfo": { "type": "string", "x-aura-field-code": "resultInfo" }, "returnRecordCount": { "type": "integer", "format": "int32", "x-aura-field-code": "returnRecordCount" }, "riskLevel": { "type": "integer", "format": "int32", "x-aura-field-code": "riskLevel", "x-aura-parameter-enumeration": { "state": "resolved", "parameter": "risk_level", "values": [ { "value": 0, "name": "Unknown", "labels": { "en": "Unknown", "tr": "Bilinmeyen", "ar": "غير معروف" } }, { "value": 1, "name": "Low", "labels": { "en": "Low", "tr": "Düşük", "ar": "منخفض" } }, { "value": 2, "name": "Medium", "labels": { "en": "Medium", "tr": "Orta", "ar": "متوسط" } }, { "value": 3, "name": "High", "labels": { "en": "High", "tr": "Yüksek", "ar": "مرتفع" } }, { "value": 4, "name": "Neutral", "labels": { "en": "Neutral", "tr": "Doğal", "ar": "محايد" } }, { "value": 5, "name": "Increased", "labels": { "en": "Increased", "tr": "Artırılmış", "ar": "زاد" } }, { "value": 6, "name": "Unacceptable", "labels": { "en": "Unacceptable", "tr": "Kabul edilemez", "ar": "غير مقبول" } } ] } }, "startValue": { "type": "string", "x-aura-field-code": "startValue" }, "tagList": { "type": "string", "x-aura-field-code": "amlInfoTagList" }, "totalProfileCount": { "type": "integer", "format": "int32", "x-aura-field-code": "totalProfileCount" }, "totalRecordCount": { "type": "integer", "format": "int32", "x-aura-field-code": "totalRecordCount" }, "whiteListMessage": { "type": "string", "x-aura-field-code": "whiteListMessage" } }, "required": [ "assignedUserGuidid", "birthYear", "citizenid", "isSafeList", "isWhiteList", "isZfs", "limitValue", "matchStatus", "maxMatchRate", "minMatchRate", "nameSearchType", "nameSearchTypeid", "nationalyFilter", "outReferenceNumber", "referenceNumber", "resultInfo", "returnRecordCount", "riskLevel", "startValue", "tagList", "totalProfileCount", "totalRecordCount", "whiteListMessage" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 23, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row'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": "create-aml-info", "x-aura-domain": "integration", "x-aura-raw-url-path": "aml-infos", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Citizenid", "declared_type": null, "nullable": false, "collection": false }, { "name": "MatchStatus", "declared_type": null, "nullable": true, "collection": false }, { "name": "RiskLevel", "declared_type": null, "nullable": true, "collection": false }, { "name": "AssignedUserGuidid", "declared_type": null, "nullable": false, "collection": false }, { "name": "TagList", "declared_type": null, "nullable": false, "collection": false }, { "name": "TotalRecordCount", "declared_type": null, "nullable": true, "collection": false }, { "name": "ReturnRecordCount", "declared_type": null, "nullable": true, "collection": false }, { "name": "StartValue", "declared_type": null, "nullable": false, "collection": false }, { "name": "LimitValue", "declared_type": null, "nullable": true, "collection": false }, { "name": "ReferenceNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "NameSearchType", "declared_type": null, "nullable": false, "collection": false }, { "name": "OutReferenceNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsWhiteList", "declared_type": null, "nullable": true, "collection": false }, { "name": "WhiteListMessage", "declared_type": null, "nullable": false, "collection": false }, { "name": "MinMatchRate", "declared_type": null, "nullable": true, "collection": false }, { "name": "MaxMatchRate", "declared_type": null, "nullable": true, "collection": false }, { "name": "BirthYear", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsSafeList", "declared_type": null, "nullable": true, "collection": false }, { "name": "NationalyFilter", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsZfs", "declared_type": null, "nullable": true, "collection": false }, { "name": "TotalProfileCount", "declared_type": null, "nullable": true, "collection": false }, { "name": "NameSearchTypeid", "declared_type": null, "nullable": true, "collection": false }, { "name": "ResultInfo", "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 } } }, "/aml-infos/by-citizenid/{citizenid}": { "delete": { "operationId": "delete-aml-info-by-citizenid", "tags": [ "aml-infos" ], "summary": "delete-aml-info-by-citizenid", "parameters": [ { "name": "citizenid", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true } } ], "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": "delete-aml-info-by-citizenid", "x-aura-domain": "integration", "x-aura-raw-url-path": "aml-infos/by-citizenid/{citizenid}", "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": "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_72", "status": 400, "message": { "ar": "معلومات أمل غير موجودة.", "en": "Aml info not found.", "tr": "Aml bilgisi bulunamadı." }, "message_available": true, "constant_name": "AML_INFO_NOT_FOUND" } ] } }, "get": { "operationId": "get-aml-info-by-citizenid", "tags": [ "aml-infos" ], "summary": "get-aml-info-by-citizenid", "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 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": "get-aml-info-by-citizenid", "x-aura-domain": "integration", "x-aura-raw-url-path": "aml-infos/by-citizenid/{citizenid}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Citizenid", "declared_type": null, "nullable": false, "collection": false }, { "name": "recordDate", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "AmlInfoDto", "payload": "AmlInfoDto", "collection": false, "members": [ { "name": "Citizenid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MatchStatus", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "RiskLevel", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "AssignedUserGuidid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TagList", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TotalRecordCount", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ReturnRecordCount", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "StartValue", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LimitValue", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ReferenceNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "NameSearchType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OutReferenceNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsWhiteList", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "WhiteListMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MinMatchRate", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "MaxMatchRate", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "BirthYear", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsSafeList", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "NationalyFilter", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsZfs", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "TotalProfileCount", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "NameSearchTypeid", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ResultInfo", "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 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is 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_17", "status": 400, "message": { "ar": "لا يمكن العثور على رقم المواطن.", "en": "Citizen Number cannot be found.", "tr": "Vatandaşlık numarası bulunamadı." }, "message_available": true, "constant_name": "CITIZEN_NUMBER_NOT_FOUND" } ] } } }, "/aml-infos/{id}": { "delete": { "operationId": "delete-aml-info", "tags": [ "aml-infos" ], "summary": "delete-aml-info", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "amlInfoId" } } ], "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": "delete-aml-info", "x-aura-domain": "integration", "x-aura-raw-url-path": "aml-infos/{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" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is 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_72", "status": 400, "message": { "ar": "معلومات أمل غير موجودة.", "en": "Aml info not found.", "tr": "Aml bilgisi bulunamadı." }, "message_available": true, "constant_name": "AML_INFO_NOT_FOUND" } ] } } }, "/aml-item-configs": { "get": { "operationId": "get-aml-item-config-list", "tags": [ "aml-item-configs" ], "summary": "get-aml-item-config-list", "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. 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": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "amlItemConfigId" }, "itemCode": { "type": "string", "x-aura-field-code": "itemCode" }, "itemValue": { "type": "string", "x-aura-field-code": "itemValue" }, "searchType": { "type": "integer", "format": "int32", "x-aura-field-code": "searchType" } } }, "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-aml-item-config-list", "x-aura-domain": "integration", "x-aura-raw-url-path": "aml-item-configs", "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": "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." } }, "post": { "operationId": "create-aml-item-config", "tags": [ "aml-item-configs" ], "summary": "create-aml-item-config", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCode": { "type": "string", "x-aura-field-code": "itemCode" }, "itemValue": { "type": "string", "x-aura-field-code": "itemValue" }, "searchType": { "type": "integer", "format": "int32", "x-aura-field-code": "searchType", "x-aura-parameter-enumeration": { "state": "resolved", "parameter": "search_type", "values": [ { "value": 1, "name": "Individual", "labels": { "tr": "Bireysel" } }, { "value": 2, "name": "Corporate", "labels": { "tr": "Kurumsal" } } ] } } }, "required": [ "itemCode", "itemValue", "searchType" ] } } } }, "x-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 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": "create-aml-item-config", "x-aura-domain": "integration", "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": "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_37", "status": 400, "message": { "ar": "تم العثور على إعداد بند التداول المالي (AML Item Config) بالفعل.", "en": "AML Item Config is already found.", "tr": "AML Öğesi Yapılandırması zaten mevcut." }, "message_available": true, "constant_name": "AML_ITEM_CONFIG_ALREADY_EXIST" } ] } } }, "/aml-item-configs/{id}": { "delete": { "operationId": "delete-aml-item-config", "tags": [ "aml-item-configs" ], "summary": "delete-aml-item-config", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "amlItemConfigId" } } ], "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": "delete-aml-item-config", "x-aura-domain": "integration", "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": "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_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" } ] } }, "get": { "operationId": "get-aml-item-config-by-id", "tags": [ "aml-item-configs" ], "summary": "get-aml-item-config-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "amlItemConfigId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "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": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "amlItemConfigId" }, "itemCode": { "type": "string", "x-aura-field-code": "itemCode" }, "itemValue": { "type": "string", "x-aura-field-code": "itemValue" }, "searchType": { "type": "integer", "format": "int32", "x-aura-field-code": "searchType" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what 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-aml-item-config-by-id", "x-aura-domain": "integration", "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." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is 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": "update-aml-item-config", "tags": [ "aml-item-configs" ], "summary": "update-aml-item-config", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "amlItemConfigId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemValue": { "type": "string", "x-aura-field-code": "itemValue" } }, "required": [ "itemValue" ] } } } }, "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": "update-aml-item-config", "x-aura-domain": "integration", "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": "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_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" } ] } } }, "/aml/search-by-document-number": { "get": { "operationId": "search-by-document-number", "tags": [ "aml" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "search-by-document-number", "description": "Invokes the `search-by-document-number` service definition through `GET /aml/search-by-document-number`.", "parameters": [ { "name": "documentNumber", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "documentNumber" } }, { "name": "searchType", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "searchType" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "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 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": "object", "properties": { "errorCode": { "type": "string", "x-aura-field-code": "errorCode" }, "errorMessage": { "type": "string", "x-aura-field-code": "errorMessage" }, "extraInfo": { "type": "string", "x-aura-field-code": "extraInfo" }, "httpStatusCode": { "type": "integer", "format": "int32", "x-aura-field-code": "httpStatusCode" }, "isSuccess": { "type": "boolean", "x-aura-field-code": "isSuccess" }, "result": { "type": "object", "properties": { "assignedUserGuidId": { "type": "string", "x-aura-field-code": "assignedUserGuidId" }, "birthYear": { "type": "string", "x-aura-field-code": "birthYear" }, "isSafeList": { "type": "boolean", "x-aura-field-code": "isSafeList" }, "isWhiteList": { "type": "boolean", "x-aura-field-code": "isWhiteList" }, "isZFS": { "type": "boolean", "x-aura-field-code": "isZFS" }, "limit": { "type": "integer", "format": "int32", "x-aura-field-code": "limit" }, "matchStatusId": { "type": "integer", "format": "int32", "x-aura-field-code": "matchStatusId" }, "maxMatchRate": { "type": "integer", "format": "int32", "x-aura-field-code": "maxMatchRate" }, "minMatchRate": { "type": "integer", "format": "int32", "x-aura-field-code": "minMatchRate" }, "nameSearchType": { "type": "string", "x-aura-field-code": "nameSearchType" }, "nameSearchTypeId": { "type": "integer", "format": "int32", "x-aura-field-code": "nameSearchTypeId" }, "nationalyFilter": { "type": "string", "x-aura-field-code": "nationalyFilter" }, "outReferenceNumber": { "type": "string", "x-aura-field-code": "outReferenceNumber" }, "referenceNumber": { "type": "string", "x-aura-field-code": "referenceNumber" }, "result": { "type": "array", "items": { "type": "object", "properties": { "addressDetails": { "type": "array", "items": { "type": "object", "properties": { "city": { "type": "string", "x-aura-field-code": "city", "x-aura-maskable": true }, "country": { "type": "string", "x-aura-field-code": "addressDetailsCountry" }, "isoCode": { "type": "string", "x-aura-field-code": "isoCode" }, "number": { "type": "string", "x-aura-field-code": "number" }, "otherInformation": { "type": "string", "x-aura-field-code": "otherInformation" }, "state": { "type": "integer", "format": "int32", "x-aura-field-code": "state" }, "street": { "type": "string", "x-aura-field-code": "street", "x-aura-maskable": true }, "zipCode": { "type": "string", "x-aura-field-code": "zipCode" } }, "x-aura-field-code": "addressDetails" } }, "basis": { "type": "string", "x-aura-field-code": "basis" }, "birthDate": { "type": "string", "x-aura-field-code": "resultBirthDate" }, "birthDetails": { "type": "array", "items": { "type": "object", "properties": { "birthCountry": { "type": "string", "x-aura-field-code": "birthDetailsBirthCountry" }, "birthDate": { "type": "string", "x-aura-field-code": "birthDetailsBirthDate" }, "birthPlace": { "type": "string", "x-aura-field-code": "birthDetailsBirthPlace" }, "birthYear": { "type": "string", "x-aura-field-code": "birthYear" }, "otherInformation": { "type": "string", "x-aura-field-code": "otherInformation" } }, "x-aura-field-code": "birthDetails" } }, "blackListTypeId": { "type": "string", "x-aura-field-code": "blackListTypeId" }, "blacklistFlagCode": { "type": "string", "x-aura-field-code": "blacklistFlagCode" }, "blacklistName": { "type": "string", "x-aura-field-code": "blacklistName" }, "citizenDetail": { "type": "string", "x-aura-field-code": "citizenDetail" }, "committees": { "type": "string", "x-aura-field-code": "committees" }, "contactDetails": { "type": "string", "x-aura-field-code": "contactDetails" }, "country": { "type": "string", "x-aura-field-code": "resultCountry" }, "countryCode": { "type": "string", "x-aura-field-code": "countryCode" }, "dataSource": { "type": "string", "x-aura-field-code": "dataSource" }, "deathDate": { "type": "string", "x-aura-field-code": "resultDeathDate" }, "deathYear": { "type": "integer", "format": "int32", "x-aura-field-code": "deathYear" }, "designation": { "type": "string", "x-aura-field-code": "designation" }, "documents": { "type": "array", "items": { "type": "object", "properties": { "documentCity": { "type": "string", "x-aura-field-code": "documentCity" }, "documentCountry": { "type": "string", "x-aura-field-code": "documentCountry" }, "documentNumber": { "type": "string", "x-aura-field-code": "documentNumber" }, "documentType": { "type": "integer", "format": "int32", "x-aura-field-code": "documentType" }, "documentTypeInformation": { "type": "string", "x-aura-field-code": "documentTypeInformation" }, "expirationDate": { "type": "string", "x-aura-field-code": "expirationDate" }, "issueDate": { "type": "string", "x-aura-field-code": "documentsIssueDate" }, "otherInformation": { "type": "string", "x-aura-field-code": "otherInformation" } }, "x-aura-field-code": "documents" } }, "email": { "type": "string", "x-aura-field-code": "email" }, "entityType": { "type": "string", "x-aura-field-code": "resultEntityType" }, "fatherName": { "type": "string", "x-aura-field-code": "fatherName" }, "firstName": { "type": "string", "x-aura-field-code": "firstName" }, "firstSeen": { "type": "string", "x-aura-field-code": "firstSeen" }, "fullName": { "type": "string", "x-aura-field-code": "fullName" }, "function": { "type": "string", "x-aura-field-code": "function" }, "gender": { "type": "string", "x-aura-field-code": "resultGender" }, "honoricPrefix": { "type": "string", "x-aura-field-code": "honoricPrefix" }, "honoricSuffix": { "type": "string", "x-aura-field-code": "honoricSuffix" }, "images": { "type": "array", "items": { "type": "object", "properties": { "dataSource": { "type": "string", "x-aura-field-code": "dataSource" }, "link": { "type": "string", "x-aura-field-code": "link" }, "otherInformation": { "type": "string", "x-aura-field-code": "otherInformation" } }, "x-aura-field-code": "images" } }, "isAutoResolved": { "type": "boolean", "x-aura-field-code": "isAutoResolved" }, "isMatchAka": { "type": "boolean", "x-aura-field-code": "isMatchAka" }, "justification": { "type": "string", "x-aura-field-code": "justification" }, "language": { "type": "string", "x-aura-field-code": "language" }, "lastName": { "type": "string", "x-aura-field-code": "lastName" }, "lastSeen": { "type": "string", "x-aura-field-code": "lastSeen" }, "lastUpdateDate": { "type": "string", "x-aura-field-code": "lastUpdateDate" }, "links": { "type": "array", "items": { "type": "object", "properties": { "dataSource": { "type": "string", "x-aura-field-code": "dataSource" }, "link": { "type": "string", "x-aura-field-code": "link" }, "otherInformation": { "type": "string", "x-aura-field-code": "otherInformation" } }, "x-aura-field-code": "links" } }, "listedOn": { "type": "string", "x-aura-field-code": "listedOn" }, "listingInformation": { "type": "string", "x-aura-field-code": "listingInformation" }, "matchRate": { "type": "integer", "format": "int32", "x-aura-field-code": "matchRate" }, "mediaData": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "x-aura-field-code": "mediaDataId" }, "link": { "type": "string", "x-aura-field-code": "link" }, "title": { "type": "string", "x-aura-field-code": "title" } }, "x-aura-field-code": "mediaData" } }, "memberShipData": { "type": "array", "items": { "type": "object", "properties": { "constituencyArea": { "type": "string", "x-aura-field-code": "constituencyArea" }, "eventClassification": { "type": "string", "x-aura-field-code": "eventClassification" }, "eventEndDate": { "type": "string", "x-aura-field-code": "eventEndDate" }, "eventName": { "type": "string", "x-aura-field-code": "eventName" }, "eventOrganizationName": { "type": "string", "x-aura-field-code": "eventOrganizationName" }, "eventStartDate": { "type": "string", "x-aura-field-code": "eventStartDate" }, "organizationClassification": { "type": "string", "x-aura-field-code": "organizationClassification" }, "organizationId": { "type": "string", "x-aura-field-code": "memberShipDataOrganizationId" }, "organizationImage": { "type": "string", "x-aura-field-code": "organizationImage" }, "organizationName": { "type": "string", "x-aura-field-code": "organizationName" }, "organizationSrgb": { "type": "string", "x-aura-field-code": "organizationSrgb" }, "organizationWebsite": { "type": "string", "x-aura-field-code": "organizationWebsite" }, "partyClassification": { "type": "string", "x-aura-field-code": "partyClassification" }, "partyImage": { "type": "string", "x-aura-field-code": "partyImage" }, "partyName": { "type": "string", "x-aura-field-code": "partyName" }, "partyShortName": { "type": "string", "x-aura-field-code": "partyShortName" }, "partySrgb": { "type": "string", "x-aura-field-code": "partySrgb" }, "partyWebsite": { "type": "string", "x-aura-field-code": "partyWebsite" }, "role": { "type": "string", "x-aura-field-code": "role" }, "sources": { "type": "string", "x-aura-field-code": "sources" } }, "x-aura-field-code": "memberShipData" } }, "middleName": { "type": "string", "x-aura-field-code": "middleName" }, "modifications": { "type": "array", "items": { "type": "object", "properties": { "effectiveDate": { "type": "string", "x-aura-field-code": "effectiveDate" }, "enactmentDate": { "type": "string", "x-aura-field-code": "enactmentDate" }, "modificationType": { "type": "string", "x-aura-field-code": "modificationType" }, "otherInformation": { "type": "string", "x-aura-field-code": "otherInformation" }, "processName": { "type": "string", "x-aura-field-code": "processName" }, "publicationDate": { "type": "string", "x-aura-field-code": "publicationDate" } }, "x-aura-field-code": "modifications" } }, "nationality": { "type": "string", "x-aura-field-code": "resultNationality" }, "origin": { "type": "string", "x-aura-field-code": "origin" }, "otherInformation": { "type": "string", "x-aura-field-code": "otherInformation" }, "otherNames": { "type": "array", "items": { "type": "object", "properties": { "fullName": { "type": "string", "x-aura-field-code": "fullName" }, "language": { "type": "string", "x-aura-field-code": "language" }, "nameType": { "type": "string", "x-aura-field-code": "nameType" }, "otherInformation": { "type": "string", "x-aura-field-code": "otherInformation" }, "quality": { "type": "string", "x-aura-field-code": "quality" } }, "x-aura-field-code": "otherNames" } }, "pepClass": { "type": "string", "x-aura-field-code": "pepClass" }, "pepClassId": { "type": "integer", "format": "int32", "x-aura-field-code": "pepClassId" }, "position": { "type": "string", "x-aura-field-code": "position" }, "profileKey": { "type": "string", "x-aura-field-code": "profileKey" }, "programKey": { "type": "string", "x-aura-field-code": "programKey" }, "programName": { "type": "string", "x-aura-field-code": "programName" }, "recordUniqueNumber": { "type": "string", "x-aura-field-code": "recordUniqueNumber" }, "registeredNumber": { "type": "string", "x-aura-field-code": "registeredNumber" }, "remark": { "type": "string", "x-aura-field-code": "remark" }, "sanctionSet": { "type": "string", "x-aura-field-code": "sanctionSet" }, "ssid": { "type": "string", "x-aura-field-code": "ssid" }, "submittedBy": { "type": "string", "x-aura-field-code": "submittedBy" }, "summary": { "type": "string", "x-aura-field-code": "summary" }, "title": { "type": "string", "x-aura-field-code": "title" }, "type": { "type": "string", "x-aura-field-code": "resultType" }, "vesselCallSign": { "type": "string", "x-aura-field-code": "vesselCallSign" }, "vesselFlag": { "type": "string", "x-aura-field-code": "vesselFlag" }, "vesselGrossRegisteredTonnage": { "type": "string", "x-aura-field-code": "vesselGrossRegisteredTonnage" }, "vesselOwner": { "type": "string", "x-aura-field-code": "vesselOwner" }, "vesselTonnage": { "type": "string", "x-aura-field-code": "vesselTonnage" }, "vesselType": { "type": "string", "x-aura-field-code": "vesselType" } }, "x-aura-field-code": "amlResultResult" } }, "returnRecordCount": { "type": "integer", "format": "int32", "x-aura-field-code": "returnRecordCount" }, "riskLevelId": { "type": "integer", "format": "int32", "x-aura-field-code": "amlRiskLevelId" }, "start": { "type": "integer", "format": "int32", "x-aura-field-code": "start" }, "tagList": { "type": "array", "items": { "type": "integer", "format": "int32", "x-aura-field-code": "tagList" } }, "totalProfileCount": { "type": "integer", "format": "int32", "x-aura-field-code": "totalProfileCount" }, "totalRecordCount": { "type": "integer", "format": "int32", "x-aura-field-code": "totalRecordCount" }, "whiteListMessage": { "type": "string", "x-aura-field-code": "whiteListMessage" } }, "x-aura-field-code": "amlResult" } }, "x-aura-field-code": "externalServiceResult" }, "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": "search-by-document-number", "x-aura-domain": "integration", "x-aura-raw-url-path": "aml/search-by-document-number", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "DocumentNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "SearchType", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ExternalServiceResultDto", "envelopes": [ "ExternalServiceResultDto" ], "payload": "AmlResponseDto", "collection": false, "members": [ { "name": "HttpStatusCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsSuccess", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "ErrorCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ErrorMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExtraInfo", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Result", "declared_type": "ResultSummary", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/aml/search-by-identity/{citizenNumber}": { "get": { "operationId": "search-by-identity", "tags": [ "aml" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "search-by-identity", "description": "Invokes the `search-by-identity` service definition through `GET /aml/search-by-identity/{citizenNumber}`.", "parameters": [ { "name": "citizenNumber", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "citizenNumber" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "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": "object", "properties": { "errorCode": { "type": "string", "x-aura-field-code": "errorCode" }, "errorMessage": { "type": "string", "x-aura-field-code": "errorMessage" }, "extraInfo": { "type": "string", "x-aura-field-code": "extraInfo" }, "httpStatusCode": { "type": "integer", "format": "int32", "x-aura-field-code": "httpStatusCode" }, "isSuccess": { "type": "boolean", "x-aura-field-code": "isSuccess" }, "result": { "type": "object", "properties": { "assignedUserGuidId": { "type": "string", "x-aura-field-code": "assignedUserGuidId" }, "birthYear": { "type": "string", "x-aura-field-code": "birthYear" }, "isSafeList": { "type": "boolean", "x-aura-field-code": "isSafeList" }, "isWhiteList": { "type": "boolean", "x-aura-field-code": "isWhiteList" }, "isZFS": { "type": "boolean", "x-aura-field-code": "isZFS" }, "limit": { "type": "integer", "format": "int32", "x-aura-field-code": "limit" }, "matchStatusId": { "type": "integer", "format": "int32", "x-aura-field-code": "matchStatusId" }, "maxMatchRate": { "type": "integer", "format": "int32", "x-aura-field-code": "maxMatchRate" }, "minMatchRate": { "type": "integer", "format": "int32", "x-aura-field-code": "minMatchRate" }, "nameSearchType": { "type": "string", "x-aura-field-code": "nameSearchType" }, "nameSearchTypeId": { "type": "integer", "format": "int32", "x-aura-field-code": "nameSearchTypeId" }, "nationalyFilter": { "type": "string", "x-aura-field-code": "nationalyFilter" }, "outReferenceNumber": { "type": "string", "x-aura-field-code": "outReferenceNumber" }, "referenceNumber": { "type": "string", "x-aura-field-code": "referenceNumber" }, "result": { "type": "array", "items": { "type": "object", "properties": { "addressDetails": { "type": "array", "items": { "type": "object", "properties": { "city": { "type": "string", "x-aura-field-code": "city", "x-aura-maskable": true }, "country": { "type": "string", "x-aura-field-code": "addressDetailsCountry" }, "isoCode": { "type": "string", "x-aura-field-code": "isoCode" }, "number": { "type": "string", "x-aura-field-code": "number" }, "otherInformation": { "type": "string", "x-aura-field-code": "otherInformation" }, "state": { "type": "integer", "format": "int32", "x-aura-field-code": "state" }, "street": { "type": "string", "x-aura-field-code": "street", "x-aura-maskable": true }, "zipCode": { "type": "string", "x-aura-field-code": "zipCode" } }, "x-aura-field-code": "addressDetails" } }, "basis": { "type": "string", "x-aura-field-code": "basis" }, "birthDate": { "type": "string", "x-aura-field-code": "resultBirthDate" }, "birthDetails": { "type": "array", "items": { "type": "object", "properties": { "birthCountry": { "type": "string", "x-aura-field-code": "birthDetailsBirthCountry" }, "birthDate": { "type": "string", "x-aura-field-code": "birthDetailsBirthDate" }, "birthPlace": { "type": "string", "x-aura-field-code": "birthDetailsBirthPlace" }, "birthYear": { "type": "string", "x-aura-field-code": "birthYear" }, "otherInformation": { "type": "string", "x-aura-field-code": "otherInformation" } }, "x-aura-field-code": "birthDetails" } }, "blackListTypeId": { "type": "string", "x-aura-field-code": "blackListTypeId" }, "blacklistFlagCode": { "type": "string", "x-aura-field-code": "blacklistFlagCode" }, "blacklistName": { "type": "string", "x-aura-field-code": "blacklistName" }, "citizenDetail": { "type": "string", "x-aura-field-code": "citizenDetail" }, "committees": { "type": "string", "x-aura-field-code": "committees" }, "contactDetails": { "type": "string", "x-aura-field-code": "contactDetails" }, "country": { "type": "string", "x-aura-field-code": "resultCountry" }, "countryCode": { "type": "string", "x-aura-field-code": "countryCode" }, "dataSource": { "type": "string", "x-aura-field-code": "dataSource" }, "deathDate": { "type": "string", "x-aura-field-code": "resultDeathDate" }, "deathYear": { "type": "integer", "format": "int32", "x-aura-field-code": "deathYear" }, "designation": { "type": "string", "x-aura-field-code": "designation" }, "documents": { "type": "array", "items": { "type": "object", "properties": { "documentCity": { "type": "string", "x-aura-field-code": "documentCity" }, "documentCountry": { "type": "string", "x-aura-field-code": "documentCountry" }, "documentNumber": { "type": "string", "x-aura-field-code": "documentNumber" }, "documentType": { "type": "integer", "format": "int32", "x-aura-field-code": "documentType" }, "documentTypeInformation": { "type": "string", "x-aura-field-code": "documentTypeInformation" }, "expirationDate": { "type": "string", "x-aura-field-code": "expirationDate" }, "issueDate": { "type": "string", "x-aura-field-code": "documentsIssueDate" }, "otherInformation": { "type": "string", "x-aura-field-code": "otherInformation" } }, "x-aura-field-code": "documents" } }, "email": { "type": "string", "x-aura-field-code": "email" }, "entityType": { "type": "string", "x-aura-field-code": "resultEntityType" }, "fatherName": { "type": "string", "x-aura-field-code": "fatherName" }, "firstName": { "type": "string", "x-aura-field-code": "firstName" }, "firstSeen": { "type": "string", "x-aura-field-code": "firstSeen" }, "fullName": { "type": "string", "x-aura-field-code": "fullName" }, "function": { "type": "string", "x-aura-field-code": "function" }, "gender": { "type": "string", "x-aura-field-code": "resultGender" }, "honoricPrefix": { "type": "string", "x-aura-field-code": "honoricPrefix" }, "honoricSuffix": { "type": "string", "x-aura-field-code": "honoricSuffix" }, "images": { "type": "array", "items": { "type": "object", "properties": { "dataSource": { "type": "string", "x-aura-field-code": "dataSource" }, "link": { "type": "string", "x-aura-field-code": "link" }, "otherInformation": { "type": "string", "x-aura-field-code": "otherInformation" } }, "x-aura-field-code": "images" } }, "isAutoResolved": { "type": "boolean", "x-aura-field-code": "isAutoResolved" }, "isMatchAka": { "type": "boolean", "x-aura-field-code": "isMatchAka" }, "justification": { "type": "string", "x-aura-field-code": "justification" }, "language": { "type": "string", "x-aura-field-code": "language" }, "lastName": { "type": "string", "x-aura-field-code": "lastName" }, "lastSeen": { "type": "string", "x-aura-field-code": "lastSeen" }, "lastUpdateDate": { "type": "string", "x-aura-field-code": "lastUpdateDate" }, "links": { "type": "array", "items": { "type": "object", "properties": { "dataSource": { "type": "string", "x-aura-field-code": "dataSource" }, "link": { "type": "string", "x-aura-field-code": "link" }, "otherInformation": { "type": "string", "x-aura-field-code": "otherInformation" } }, "x-aura-field-code": "links" } }, "listedOn": { "type": "string", "x-aura-field-code": "listedOn" }, "listingInformation": { "type": "string", "x-aura-field-code": "listingInformation" }, "matchRate": { "type": "integer", "format": "int32", "x-aura-field-code": "matchRate" }, "mediaData": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "x-aura-field-code": "mediaDataId" }, "link": { "type": "string", "x-aura-field-code": "link" }, "title": { "type": "string", "x-aura-field-code": "title" } }, "x-aura-field-code": "mediaData" } }, "memberShipData": { "type": "array", "items": { "type": "object", "properties": { "constituencyArea": { "type": "string", "x-aura-field-code": "constituencyArea" }, "eventClassification": { "type": "string", "x-aura-field-code": "eventClassification" }, "eventEndDate": { "type": "string", "x-aura-field-code": "eventEndDate" }, "eventName": { "type": "string", "x-aura-field-code": "eventName" }, "eventOrganizationName": { "type": "string", "x-aura-field-code": "eventOrganizationName" }, "eventStartDate": { "type": "string", "x-aura-field-code": "eventStartDate" }, "organizationClassification": { "type": "string", "x-aura-field-code": "organizationClassification" }, "organizationId": { "type": "string", "x-aura-field-code": "memberShipDataOrganizationId" }, "organizationImage": { "type": "string", "x-aura-field-code": "organizationImage" }, "organizationName": { "type": "string", "x-aura-field-code": "organizationName" }, "organizationSrgb": { "type": "string", "x-aura-field-code": "organizationSrgb" }, "organizationWebsite": { "type": "string", "x-aura-field-code": "organizationWebsite" }, "partyClassification": { "type": "string", "x-aura-field-code": "partyClassification" }, "partyImage": { "type": "string", "x-aura-field-code": "partyImage" }, "partyName": { "type": "string", "x-aura-field-code": "partyName" }, "partyShortName": { "type": "string", "x-aura-field-code": "partyShortName" }, "partySrgb": { "type": "string", "x-aura-field-code": "partySrgb" }, "partyWebsite": { "type": "string", "x-aura-field-code": "partyWebsite" }, "role": { "type": "string", "x-aura-field-code": "role" }, "sources": { "type": "string", "x-aura-field-code": "sources" } }, "x-aura-field-code": "memberShipData" } }, "middleName": { "type": "string", "x-aura-field-code": "middleName" }, "modifications": { "type": "array", "items": { "type": "object", "properties": { "effectiveDate": { "type": "string", "x-aura-field-code": "effectiveDate" }, "enactmentDate": { "type": "string", "x-aura-field-code": "enactmentDate" }, "modificationType": { "type": "string", "x-aura-field-code": "modificationType" }, "otherInformation": { "type": "string", "x-aura-field-code": "otherInformation" }, "processName": { "type": "string", "x-aura-field-code": "processName" }, "publicationDate": { "type": "string", "x-aura-field-code": "publicationDate" } }, "x-aura-field-code": "modifications" } }, "nationality": { "type": "string", "x-aura-field-code": "resultNationality" }, "origin": { "type": "string", "x-aura-field-code": "origin" }, "otherInformation": { "type": "string", "x-aura-field-code": "otherInformation" }, "otherNames": { "type": "array", "items": { "type": "object", "properties": { "fullName": { "type": "string", "x-aura-field-code": "fullName" }, "language": { "type": "string", "x-aura-field-code": "language" }, "nameType": { "type": "string", "x-aura-field-code": "nameType" }, "otherInformation": { "type": "string", "x-aura-field-code": "otherInformation" }, "quality": { "type": "string", "x-aura-field-code": "quality" } }, "x-aura-field-code": "otherNames" } }, "pepClass": { "type": "string", "x-aura-field-code": "pepClass" }, "pepClassId": { "type": "integer", "format": "int32", "x-aura-field-code": "pepClassId" }, "position": { "type": "string", "x-aura-field-code": "position" }, "profileKey": { "type": "string", "x-aura-field-code": "profileKey" }, "programKey": { "type": "string", "x-aura-field-code": "programKey" }, "programName": { "type": "string", "x-aura-field-code": "programName" }, "recordUniqueNumber": { "type": "string", "x-aura-field-code": "recordUniqueNumber" }, "registeredNumber": { "type": "string", "x-aura-field-code": "registeredNumber" }, "remark": { "type": "string", "x-aura-field-code": "remark" }, "sanctionSet": { "type": "string", "x-aura-field-code": "sanctionSet" }, "ssid": { "type": "string", "x-aura-field-code": "ssid" }, "submittedBy": { "type": "string", "x-aura-field-code": "submittedBy" }, "summary": { "type": "string", "x-aura-field-code": "summary" }, "title": { "type": "string", "x-aura-field-code": "title" }, "type": { "type": "string", "x-aura-field-code": "resultType" }, "vesselCallSign": { "type": "string", "x-aura-field-code": "vesselCallSign" }, "vesselFlag": { "type": "string", "x-aura-field-code": "vesselFlag" }, "vesselGrossRegisteredTonnage": { "type": "string", "x-aura-field-code": "vesselGrossRegisteredTonnage" }, "vesselOwner": { "type": "string", "x-aura-field-code": "vesselOwner" }, "vesselTonnage": { "type": "string", "x-aura-field-code": "vesselTonnage" }, "vesselType": { "type": "string", "x-aura-field-code": "vesselType" } }, "x-aura-field-code": "amlResultResult" } }, "returnRecordCount": { "type": "integer", "format": "int32", "x-aura-field-code": "returnRecordCount" }, "riskLevelId": { "type": "integer", "format": "int32", "x-aura-field-code": "amlRiskLevelId" }, "start": { "type": "integer", "format": "int32", "x-aura-field-code": "start" }, "tagList": { "type": "array", "items": { "type": "integer", "format": "int32", "x-aura-field-code": "tagList" } }, "totalProfileCount": { "type": "integer", "format": "int32", "x-aura-field-code": "totalProfileCount" }, "totalRecordCount": { "type": "integer", "format": "int32", "x-aura-field-code": "totalRecordCount" }, "whiteListMessage": { "type": "string", "x-aura-field-code": "whiteListMessage" } }, "x-aura-field-code": "amlResult" } }, "x-aura-field-code": "externalServiceResult" }, "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": "search-by-identity", "x-aura-domain": "integration", "x-aura-raw-url-path": "aml/search-by-identity/{citizenNumber}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CitizenNumber", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ExternalServiceResultDto", "envelopes": [ "ExternalServiceResultDto" ], "payload": "AmlResponseDto", "collection": false, "members": [ { "name": "HttpStatusCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsSuccess", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "ErrorCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ErrorMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExtraInfo", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Result", "declared_type": "ResultSummary", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/aml/search-by-name": { "get": { "operationId": "search-by-name", "tags": [ "aml" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "search-by-name", "description": "Invokes the `search-by-name` service definition through `GET /aml/search-by-name`.", "parameters": [ { "name": "maxMatchRate", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "maxMatchRate" } }, { "name": "minMatchRate", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "minMatchRate" } }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "amlName" } }, { "name": "searchType", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "searchType" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "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": { "externalServiceResult": { "type": "object", "properties": { "errorCode": { "type": "string", "x-aura-field-code": "errorCode" }, "errorMessage": { "type": "string", "x-aura-field-code": "errorMessage" }, "extraInfo": { "type": "string", "x-aura-field-code": "extraInfo" }, "httpStatusCode": { "type": "integer", "format": "int32", "x-aura-field-code": "httpStatusCode" }, "isSuccess": { "type": "boolean", "x-aura-field-code": "isSuccess" }, "result": { "type": "object", "properties": { "assignedUserGuidId": { "type": "string", "x-aura-field-code": "assignedUserGuidId" }, "birthYear": { "type": "string", "x-aura-field-code": "birthYear" }, "isSafeList": { "type": "boolean", "x-aura-field-code": "isSafeList" }, "isWhiteList": { "type": "boolean", "x-aura-field-code": "isWhiteList" }, "isZFS": { "type": "boolean", "x-aura-field-code": "isZFS" }, "limit": { "type": "integer", "format": "int32", "x-aura-field-code": "limit" }, "matchStatusId": { "type": "integer", "format": "int32", "x-aura-field-code": "matchStatusId" }, "maxMatchRate": { "type": "integer", "format": "int32", "x-aura-field-code": "maxMatchRate" }, "minMatchRate": { "type": "integer", "format": "int32", "x-aura-field-code": "minMatchRate" }, "nameSearchType": { "type": "string", "x-aura-field-code": "nameSearchType" }, "nameSearchTypeId": { "type": "integer", "format": "int32", "x-aura-field-code": "nameSearchTypeId" }, "nationalyFilter": { "type": "string", "x-aura-field-code": "nationalyFilter" }, "outReferenceNumber": { "type": "string", "x-aura-field-code": "outReferenceNumber" }, "referenceNumber": { "type": "string", "x-aura-field-code": "referenceNumber" }, "result": { "type": "array", "items": { "type": "object", "properties": { "addressDetails": { "type": "array", "items": { "type": "object", "properties": { "city": { "type": "string", "x-aura-field-code": "city", "x-aura-maskable": true }, "country": { "type": "string", "x-aura-field-code": "addressDetailsCountry" }, "isoCode": { "type": "string", "x-aura-field-code": "isoCode" }, "number": { "type": "string", "x-aura-field-code": "number" }, "otherInformation": { "type": "string", "x-aura-field-code": "otherInformation" }, "state": { "type": "integer", "format": "int32", "x-aura-field-code": "state" }, "street": { "type": "string", "x-aura-field-code": "street", "x-aura-maskable": true }, "zipCode": { "type": "string", "x-aura-field-code": "zipCode" } }, "x-aura-field-code": "addressDetails" } }, "basis": { "type": "string", "x-aura-field-code": "basis" }, "birthDate": { "type": "string", "x-aura-field-code": "resultBirthDate" }, "birthDetails": { "type": "array", "items": { "type": "object", "properties": { "birthCountry": { "type": "string", "x-aura-field-code": "birthDetailsBirthCountry" }, "birthDate": { "type": "string", "x-aura-field-code": "birthDetailsBirthDate" }, "birthPlace": { "type": "string", "x-aura-field-code": "birthDetailsBirthPlace" }, "birthYear": { "type": "string", "x-aura-field-code": "birthYear" }, "otherInformation": { "type": "string", "x-aura-field-code": "otherInformation" } }, "x-aura-field-code": "birthDetails" } }, "blackListTypeId": { "type": "string", "x-aura-field-code": "blackListTypeId" }, "blacklistFlagCode": { "type": "string", "x-aura-field-code": "blacklistFlagCode" }, "blacklistName": { "type": "string", "x-aura-field-code": "blacklistName" }, "citizenDetail": { "type": "string", "x-aura-field-code": "citizenDetail" }, "committees": { "type": "string", "x-aura-field-code": "committees" }, "contactDetails": { "type": "string", "x-aura-field-code": "contactDetails" }, "country": { "type": "string", "x-aura-field-code": "resultCountry" }, "countryCode": { "type": "string", "x-aura-field-code": "countryCode" }, "dataSource": { "type": "string", "x-aura-field-code": "dataSource" }, "deathDate": { "type": "string", "x-aura-field-code": "resultDeathDate" }, "deathYear": { "type": "integer", "format": "int32", "x-aura-field-code": "deathYear" }, "designation": { "type": "string", "x-aura-field-code": "designation" }, "documents": { "type": "array", "items": { "type": "object", "properties": { "documentCity": { "type": "string", "x-aura-field-code": "documentCity" }, "documentCountry": { "type": "string", "x-aura-field-code": "documentCountry" }, "documentNumber": { "type": "string", "x-aura-field-code": "documentNumber" }, "documentType": { "type": "integer", "format": "int32", "x-aura-field-code": "documentType" }, "documentTypeInformation": { "type": "string", "x-aura-field-code": "documentTypeInformation" }, "expirationDate": { "type": "string", "x-aura-field-code": "expirationDate" }, "issueDate": { "type": "string", "x-aura-field-code": "documentsIssueDate" }, "otherInformation": { "type": "string", "x-aura-field-code": "otherInformation" } }, "x-aura-field-code": "documents" } }, "email": { "type": "string", "x-aura-field-code": "email" }, "entityType": { "type": "string", "x-aura-field-code": "resultEntityType" }, "fatherName": { "type": "string", "x-aura-field-code": "fatherName" }, "firstName": { "type": "string", "x-aura-field-code": "firstName" }, "firstSeen": { "type": "string", "x-aura-field-code": "firstSeen" }, "fullName": { "type": "string", "x-aura-field-code": "fullName" }, "function": { "type": "string", "x-aura-field-code": "function" }, "gender": { "type": "string", "x-aura-field-code": "resultGender" }, "honoricPrefix": { "type": "string", "x-aura-field-code": "honoricPrefix" }, "honoricSuffix": { "type": "string", "x-aura-field-code": "honoricSuffix" }, "images": { "type": "array", "items": { "type": "object", "properties": { "dataSource": { "type": "string", "x-aura-field-code": "dataSource" }, "link": { "type": "string", "x-aura-field-code": "link" }, "otherInformation": { "type": "string", "x-aura-field-code": "otherInformation" } }, "x-aura-field-code": "images" } }, "isAutoResolved": { "type": "boolean", "x-aura-field-code": "isAutoResolved" }, "isMatchAka": { "type": "boolean", "x-aura-field-code": "isMatchAka" }, "justification": { "type": "string", "x-aura-field-code": "justification" }, "language": { "type": "string", "x-aura-field-code": "language" }, "lastName": { "type": "string", "x-aura-field-code": "lastName" }, "lastSeen": { "type": "string", "x-aura-field-code": "lastSeen" }, "lastUpdateDate": { "type": "string", "x-aura-field-code": "lastUpdateDate" }, "links": { "type": "array", "items": { "type": "object", "properties": { "dataSource": { "type": "string", "x-aura-field-code": "dataSource" }, "link": { "type": "string", "x-aura-field-code": "link" }, "otherInformation": { "type": "string", "x-aura-field-code": "otherInformation" } }, "x-aura-field-code": "links" } }, "listedOn": { "type": "string", "x-aura-field-code": "listedOn" }, "listingInformation": { "type": "string", "x-aura-field-code": "listingInformation" }, "matchRate": { "type": "integer", "format": "int32", "x-aura-field-code": "matchRate" }, "mediaData": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "x-aura-field-code": "mediaDataId" }, "link": { "type": "string", "x-aura-field-code": "link" }, "title": { "type": "string", "x-aura-field-code": "title" } }, "x-aura-field-code": "mediaData" } }, "memberShipData": { "type": "array", "items": { "type": "object", "properties": { "constituencyArea": { "type": "string", "x-aura-field-code": "constituencyArea" }, "eventClassification": { "type": "string", "x-aura-field-code": "eventClassification" }, "eventEndDate": { "type": "string", "x-aura-field-code": "eventEndDate" }, "eventName": { "type": "string", "x-aura-field-code": "eventName" }, "eventOrganizationName": { "type": "string", "x-aura-field-code": "eventOrganizationName" }, "eventStartDate": { "type": "string", "x-aura-field-code": "eventStartDate" }, "organizationClassification": { "type": "string", "x-aura-field-code": "organizationClassification" }, "organizationId": { "type": "string", "x-aura-field-code": "memberShipDataOrganizationId" }, "organizationImage": { "type": "string", "x-aura-field-code": "organizationImage" }, "organizationName": { "type": "string", "x-aura-field-code": "organizationName" }, "organizationSrgb": { "type": "string", "x-aura-field-code": "organizationSrgb" }, "organizationWebsite": { "type": "string", "x-aura-field-code": "organizationWebsite" }, "partyClassification": { "type": "string", "x-aura-field-code": "partyClassification" }, "partyImage": { "type": "string", "x-aura-field-code": "partyImage" }, "partyName": { "type": "string", "x-aura-field-code": "partyName" }, "partyShortName": { "type": "string", "x-aura-field-code": "partyShortName" }, "partySrgb": { "type": "string", "x-aura-field-code": "partySrgb" }, "partyWebsite": { "type": "string", "x-aura-field-code": "partyWebsite" }, "role": { "type": "string", "x-aura-field-code": "role" }, "sources": { "type": "string", "x-aura-field-code": "sources" } }, "x-aura-field-code": "memberShipData" } }, "middleName": { "type": "string", "x-aura-field-code": "middleName" }, "modifications": { "type": "array", "items": { "type": "object", "properties": { "effectiveDate": { "type": "string", "x-aura-field-code": "effectiveDate" }, "enactmentDate": { "type": "string", "x-aura-field-code": "enactmentDate" }, "modificationType": { "type": "string", "x-aura-field-code": "modificationType" }, "otherInformation": { "type": "string", "x-aura-field-code": "otherInformation" }, "processName": { "type": "string", "x-aura-field-code": "processName" }, "publicationDate": { "type": "string", "x-aura-field-code": "publicationDate" } }, "x-aura-field-code": "modifications" } }, "nationality": { "type": "string", "x-aura-field-code": "resultNationality" }, "origin": { "type": "string", "x-aura-field-code": "origin" }, "otherInformation": { "type": "string", "x-aura-field-code": "otherInformation" }, "otherNames": { "type": "array", "items": { "type": "object", "properties": { "fullName": { "type": "string", "x-aura-field-code": "fullName" }, "language": { "type": "string", "x-aura-field-code": "language" }, "nameType": { "type": "string", "x-aura-field-code": "nameType" }, "otherInformation": { "type": "string", "x-aura-field-code": "otherInformation" }, "quality": { "type": "string", "x-aura-field-code": "quality" } }, "x-aura-field-code": "otherNames" } }, "pepClass": { "type": "string", "x-aura-field-code": "pepClass" }, "pepClassId": { "type": "integer", "format": "int32", "x-aura-field-code": "pepClassId" }, "position": { "type": "string", "x-aura-field-code": "position" }, "profileKey": { "type": "string", "x-aura-field-code": "profileKey" }, "programKey": { "type": "string", "x-aura-field-code": "programKey" }, "programName": { "type": "string", "x-aura-field-code": "programName" }, "recordUniqueNumber": { "type": "string", "x-aura-field-code": "recordUniqueNumber" }, "registeredNumber": { "type": "string", "x-aura-field-code": "registeredNumber" }, "remark": { "type": "string", "x-aura-field-code": "remark" }, "sanctionSet": { "type": "string", "x-aura-field-code": "sanctionSet" }, "ssid": { "type": "string", "x-aura-field-code": "ssid" }, "submittedBy": { "type": "string", "x-aura-field-code": "submittedBy" }, "summary": { "type": "string", "x-aura-field-code": "summary" }, "title": { "type": "string", "x-aura-field-code": "title" }, "type": { "type": "string", "x-aura-field-code": "resultType" }, "vesselCallSign": { "type": "string", "x-aura-field-code": "vesselCallSign" }, "vesselFlag": { "type": "string", "x-aura-field-code": "vesselFlag" }, "vesselGrossRegisteredTonnage": { "type": "string", "x-aura-field-code": "vesselGrossRegisteredTonnage" }, "vesselOwner": { "type": "string", "x-aura-field-code": "vesselOwner" }, "vesselTonnage": { "type": "string", "x-aura-field-code": "vesselTonnage" }, "vesselType": { "type": "string", "x-aura-field-code": "vesselType" } }, "x-aura-field-code": "amlResultResult" } }, "returnRecordCount": { "type": "integer", "format": "int32", "x-aura-field-code": "returnRecordCount" }, "riskLevelId": { "type": "integer", "format": "int32", "x-aura-field-code": "amlRiskLevelId" }, "start": { "type": "integer", "format": "int32", "x-aura-field-code": "start" }, "tagList": { "type": "array", "items": { "type": "integer", "format": "int32", "x-aura-field-code": "tagList" } }, "totalProfileCount": { "type": "integer", "format": "int32", "x-aura-field-code": "totalProfileCount" }, "totalRecordCount": { "type": "integer", "format": "int32", "x-aura-field-code": "totalRecordCount" }, "whiteListMessage": { "type": "string", "x-aura-field-code": "whiteListMessage" } }, "x-aura-field-code": "amlResult" } }, "x-aura-field-code": "externalServiceResult" }, "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": "search-by-name", "x-aura-domain": "integration", "x-aura-raw-url-path": "aml/search-by-name", "x-aura-request-contract": { "state": "no-members" }, "x-aura-code-response": { "state": "structure", "declared_type": "ExternalServiceResultDto", "envelopes": [ "ExternalServiceResultDto" ], "payload": "AmlResponseDto", "collection": false, "members": [ { "name": "HttpStatusCode", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsSuccess", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "ErrorCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ErrorMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExtraInfo", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Result", "declared_type": "ResultSummary", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/batch-catalog": { "post": { "operationId": "integration-batch-catalog", "tags": [ "batch-catalog" ], "summary": "integration-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. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "integration-batch-catalog", "x-aura-domain": "integration", "x-aura-raw-url-path": "batch-catalog", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "declared-non-dto", "note": "The route declares `IEnumerable`. `object` is the C# base type, so the code states that a body is returned and declines to say what is in it — the shape is chosen at runtime, and the body is a JSON array whose elements need not share a shape. That is the declaration, not a failure to read it, and nothing here narrows it.", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "object" } } }, "/card/activate-prepaid-card": { "post": { "operationId": "activate-prepaid-card", "tags": [ "card" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "Activate Prepaid Card", "description": "Invokes the `activate-prepaid-card` service definition through `POST /card/activate-prepaid-card`.\n\nTurkish display name: Ön Ödemeli Kartı Etkinleştir", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "barcode": { "type": "string", "x-aura-field-code": "barcode" }, "cardToken": { "type": "string", "x-aura-field-code": "cardToken" }, "email": { "type": "string", "x-aura-field-code": "email" }, "identityNumber": { "type": "string", "x-aura-field-code": "identityNumber" }, "identityType": { "type": "string", "x-aura-field-code": "prepaidCardIdentityType" }, "mobilePhoneNumber": { "type": "string", "x-aura-field-code": "mobilePhoneNumber" }, "name1": { "type": "string", "x-aura-field-code": "name1" }, "name2": { "type": "string", "x-aura-field-code": "name2" }, "surname": { "type": "string", "x-aura-field-code": "surname", "x-aura-maskable": true } }, "required": [ "name1", "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": 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 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": "activate-prepaid-card", "x-aura-domain": "integration", "x-aura-raw-url-path": "card/activate-prepaid-card", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Name1", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name2", "declared_type": null, "nullable": false, "collection": false }, { "name": "Surname", "declared_type": null, "nullable": false, "collection": false }, { "name": "CardToken", "declared_type": null, "nullable": false, "collection": false }, { "name": "IdentityType", "declared_type": null, "nullable": false, "collection": false }, { "name": "IdentityNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "MobilePhoneNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "Barcode", "declared_type": null, "nullable": false, "collection": false }, { "name": "Email", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ExternalServiceResultDto", "envelopes": [ "ExternalServiceResultDto" ], "payload": "ActivatePrepaidCardDto", "collection": false, "members": [ { "name": "ResponseCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ResponseMessage", "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 } } }, "/card/create-virtual-card": { "post": { "operationId": "create-virtual-card", "tags": [ "card" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "Create Virtual Card", "description": "Invokes the `create-virtual-card` service definition through `POST /card/create-virtual-card`.\n\nTurkish display name: Sanal Kart Oluştur", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "prepaidFirmNumber": { "type": "string", "x-aura-field-code": "prepaidFirmNumber" }, "productNumber": { "type": "string", "x-aura-field-code": "productNumber" }, "subProductName": { "type": "string", "x-aura-field-code": "subProductName" }, "subProductNumber": { "type": "string", "x-aura-field-code": "subProductNumber" } }, "required": [ "prepaidFirmNumber", "productNumber", "subProductNumber" ] } } } }, "x-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": "create-virtual-card", "x-aura-domain": "integration", "x-aura-raw-url-path": "card/create-virtual-card", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "ProductNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "SubProductNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "SubProductName", "declared_type": null, "nullable": false, "collection": false }, { "name": "PrepaidFirmNumber", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ExternalServiceResultDto", "envelopes": [ "ExternalServiceResultDto" ], "payload": "CreateVirtualCardDto", "collection": false, "members": [ { "name": "CardToken", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MaskedCardNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "EncryptedCardNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "EncryptedCvv", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExpiryDate", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Barcode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CardStatusCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ResponseCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ResponseMessage", "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 } } }, "/compensating-transactions/commit": { "post": { "operationId": "integration-commit-compensating-transaction", "tags": [ "compensating-transactions" ], "summary": "integration-commit-compensating-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. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "integration-commit-compensating-transaction", "x-aura-domain": "integration", "x-aura-raw-url-path": "compensating-transactions/commit", "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" } } }, "/compensating-transactions/rollback": { "post": { "operationId": "integration-rollback-compensating-transaction", "tags": [ "compensating-transactions" ], "summary": "integration-rollback-compensating-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. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "integration-rollback-compensating-transaction", "x-aura-domain": "integration", "x-aura-raw-url-path": "compensating-transactions/rollback", "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" } } }, "/credit-bureau-infos/access-token-for-risk-center": { "post": { "operationId": "create-credit-bureau-token", "tags": [ "credit-bureau-infos" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "create-credit-bureau-token", "description": "Invokes the `create-credit-bureau-token` service definition through `POST /credit-bureau-infos/access-token-for-risk-center`.", "x-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": "create-credit-bureau-token", "x-aura-domain": "integration", "x-aura-raw-url-path": "credit-bureau-infos/access-token-for-risk-center", "x-aura-request-contract": { "state": "no-members" }, "x-aura-code-response": { "state": "structure", "declared_type": "CreateCreditBureauTokenDto", "payload": "CreateCreditBureauTokenDto", "collection": false, "members": [ { "name": "AccessToken", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TokenType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExpireIn", "declared_type": "int", "nullable": false, "collection": false }, { "name": "RefreshToken", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Scope", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/credit-bureau-infos/individual-queries/internal/by-citizenid/{citizenId}": { "get": { "operationId": "get-individual-query-internal", "tags": [ "credit-bureau-infos" ], "summary": "get-individual-query-internal", "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": { "citizenId": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "citizenIdType": { "type": "integer", "format": "int32", "x-aura-field-code": "citizenidType" }, "clFirstCreditUtilizationDate": { "type": "string", "format": "date", "x-aura-field-code": "clFirstCreditUtilizationDate" }, "clLastCreditUtilizationDate": { "type": "string", "format": "date", "x-aura-field-code": "clLastCreditUtilizationDate" }, "clMostRecentLimitAllocationDate": { "type": "string", "format": "date", "x-aura-field-code": "clMostRecentLimitAllocationDate" }, "clNearestFollowingDate": { "type": "string", "format": "date", "x-aura-field-code": "clNearestFollowingDate" }, "clNumberOfDelinquentAccount": { "type": "integer", "format": "int32", "x-aura-field-code": "clNumberOfDelinquentAccount" }, "clNumberOfFinancialInstitutionsReportingLegalFollow": { "type": "integer", "format": "int32", "x-aura-field-code": "clNumberOfFinancialInstitutionsReportingLegalFollow" }, "clNumberOfReportingFinancialInstitution": { "type": "integer", "format": "int32", "x-aura-field-code": "clNumberOfReportingFinancialInstitution" }, "clOldestFollowingDate": { "type": "string", "format": "date", "x-aura-field-code": "clOldestFollowingDate" }, "clTotalCashLimit": { "type": "number", "format": "decimal", "x-aura-field-code": "clTotalCashLimit" }, "clTotalCashRisk": { "type": "number", "format": "decimal", "x-aura-field-code": "clTotalCashRisk" }, "clTotalCurrentCreditBalance": { "type": "number", "format": "decimal", "x-aura-field-code": "clTotalCurrentCreditBalance" }, "clTotalDelinquentBalance": { "type": "number", "format": "decimal", "x-aura-field-code": "clTotalDelinquentBalance" }, "clTotalLimit": { "type": "number", "format": "decimal", "x-aura-field-code": "clTotalLimit" }, "clTotalNonCashLimit": { "type": "number", "format": "decimal", "x-aura-field-code": "clTotalNonCashLimit" }, "clTotalNonCashRisk": { "type": "number", "format": "decimal", "x-aura-field-code": "clTotalNonCashRisk" }, "clTotalRisk": { "type": "number", "format": "decimal", "x-aura-field-code": "clTotalRisk" }, "clTotalRiskAmountAtTheTimeOfLegalFollow": { "type": "number", "format": "decimal", "x-aura-field-code": "clTotalRiskAmountAtTheTimeOfLegalFollow" }, "cosIsDataFound": { "type": "boolean", "x-aura-field-code": "cosIsDataFound" }, "cosResult": { "type": "string", "x-aura-field-code": "cosResult" }, "crsIsDataFound": { "type": "boolean", "x-aura-field-code": "crsIsDataFound" }, "crsResult": { "type": "string", "x-aura-field-code": "crsResult" }, "entityType": { "type": "string", "x-aura-field-code": "entityTypeString" }, "errorCode": { "type": "string", "x-aura-field-code": "errorCode" }, "externalServiceResultId": { "type": "string", "format": "uuid", "x-aura-field-code": "externalServiceResultId" }, "ilAccountStatement": { "type": "array", "items": { "type": "object", "properties": { "ilBalanceInDefault": { "type": "number", "format": "decimal", "x-aura-field-code": "ilBalanceInDefault" }, "ilBalanceUnderMonitoring": { "type": "number", "format": "decimal", "x-aura-field-code": "ilBalanceUnderMonitoring" }, "ilClosingDate": { "type": "string", "format": "date", "x-aura-field-code": "ilAccountStatementClosingDate" }, "ilCreditLimit": { "type": "number", "format": "decimal", "x-aura-field-code": "ilCreditLimit" }, "ilCurrencyCode": { "type": "integer", "format": "int32", "x-aura-field-code": "ilAccountStatementCurrencyCode" }, "ilDailyDelayedBalance": { "type": "number", "format": "decimal", "x-aura-field-code": "ilDailyDelayedBalance" }, "ilDailyPaymentStatus": { "type": "string", "x-aura-field-code": "ilDailyPaymentStatus" }, "ilInstallmentAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "ilInstallmentAmount" }, "ilInstallmentBalance": { "type": "number", "format": "decimal", "x-aura-field-code": "ilInstallmentBalance" }, "ilInstitutionIdentifier": { "type": "string", "x-aura-field-code": "ilInstitutionIdentifier" }, "ilLastPaymentAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "ilLastPaymentAmount" }, "ilLastUpdateDate": { "type": "string", "format": "date", "x-aura-field-code": "ilAccountStatementLastUpdateDate" }, "ilLoanType": { "type": "string", "x-aura-field-code": "ilLoanType" }, "ilMonitoringDate": { "type": "string", "format": "date", "x-aura-field-code": "ilMonitoringDate" }, "ilNumberOfInstallment": { "type": "integer", "format": "int32", "x-aura-field-code": "ilNumberOfInstallment" }, "ilOpeningDate": { "type": "string", "format": "date", "x-aura-field-code": "ilAccountStatementOpeningDate" }, "ilPaymentPerformanceHistory": { "type": "string", "x-aura-field-code": "ilPaymentPerformanceHistory" }, "ilRecordReferenceNumber": { "type": "string", "x-aura-field-code": "ilRecordReferenceNumber" }, "ilResponsibilityStatus": { "type": "string", "x-aura-field-code": "ilResponsibilityStatus" }, "ilSequenceNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "ilSequenceNumber" }, "ilTotalBalance": { "type": "number", "format": "decimal", "x-aura-field-code": "ilTotalBalance" }, "ilWorstPaymentHistory": { "type": "string", "x-aura-field-code": "ilWorstPaymentHistory" } }, "x-aura-field-code": "ilAccountStatement" } }, "ilAssetManagement": { "type": "array", "items": { "type": "object", "properties": { "ilClosingDate": { "type": "string", "format": "date", "x-aura-field-code": "ilAssetManagementClosingDate" }, "ilCurrencyCode": { "type": "integer", "format": "int32", "x-aura-field-code": "ilAssetManagementCurrencyCode" }, "ilDebtStatus": { "type": "string", "x-aura-field-code": "ilDebtStatus" }, "ilLastUpdateDate": { "type": "string", "format": "date", "x-aura-field-code": "ilAssetManagementLastUpdateDate" }, "ilMemberUsername": { "type": "string", "x-aura-field-code": "ilMemberUsername" }, "ilMembershipCode": { "type": "string", "x-aura-field-code": "ilMembershipCode" }, "ilNumberOfTransfersReceivedFromDifferentMember": { "type": "integer", "format": "int32", "x-aura-field-code": "ilNumberOfTransfersReceivedFromDifferentMember" }, "ilOpeningDate": { "type": "string", "format": "date", "x-aura-field-code": "ilAssetManagementOpeningDate" }, "ilOutstandingDebt": { "type": "number", "format": "decimal", "x-aura-field-code": "ilOutstandingDebt" }, "ilPaidDebt": { "type": "number", "format": "decimal", "x-aura-field-code": "ilPaidDebt" }, "ilReferenceNumber": { "type": "string", "x-aura-field-code": "ilReferenceNumber" }, "ilTotalRevolvingBalanceInBaseCurrency": { "type": "number", "format": "decimal", "x-aura-field-code": "ilTotalRevolvingBalanceInBaseCurrency" }, "ilTotalTransferredAssignment": { "type": "integer", "format": "int32", "x-aura-field-code": "ilTotalTransferredAssignment" } }, "x-aura-field-code": "ilAssetManagement" } }, "ilCreditScore": { "type": "string", "x-aura-field-code": "ilCreditScore" }, "ilCreditScoreReasons": { "type": "array", "items": { "type": "object", "properties": { "ilCreditScoreReasonCode": { "type": "string", "x-aura-field-code": "ilCreditScoreReasonCode" }, "sequenceNo": { "type": "integer", "format": "int32", "x-aura-field-code": "ilReasonSequenceNo" } }, "x-aura-field-code": "ilCreditScoreReasons" } }, "ilCurrentLongestDelayDuration": { "type": "integer", "format": "int32", "x-aura-field-code": "ilCurrentLongestDelayDuration" }, "ilDateOfLastLegalFollow": { "type": "string", "format": "date", "x-aura-field-code": "ilDateOfLastLegalFollow" }, "ilExclusionCode": { "type": "string", "x-aura-field-code": "ilExclusionCode" }, "ilLastCreditUtilizationDate": { "type": "string", "format": "date", "x-aura-field-code": "ilLastCreditUtilizationDate" }, "ilNumberOfFinancialInstitutionsReportingLegalFollow": { "type": "integer", "format": "int32", "x-aura-field-code": "ilNumberOfFinancialInstitutionsReportingLegalFollow" }, "ilNumberOfOngoingLegalFollowCredit": { "type": "integer", "format": "int32", "x-aura-field-code": "ilNumberOfOngoingLegalFollowCredit" }, "ilNumberOfReportingFinancialInstitution": { "type": "integer", "format": "int32", "x-aura-field-code": "ilNumberOfReportingFinancialInstitution" }, "ilTotalCreditAccountsCount": { "type": "integer", "format": "int32", "x-aura-field-code": "ilTotalCreditAccountsCount" }, "ilTotalDelayedBalance": { "type": "number", "format": "decimal", "x-aura-field-code": "ilTotalDelayedBalance" }, "ilTotalLegalFollowBalance": { "type": "number", "format": "decimal", "x-aura-field-code": "ilTotalLegalFollowBalance" }, "ilTotalLimit": { "type": "number", "format": "decimal", "x-aura-field-code": "ilTotalLimit" }, "ilTotalNumberOfDelinquentAccount": { "type": "integer", "format": "int32", "x-aura-field-code": "ilTotalNumberOfDelinquentAccount" }, "ilTotalRisk": { "type": "number", "format": "decimal", "x-aura-field-code": "ilTotalRisk" }, "individualDebtIndex": { "type": "string", "x-aura-field-code": "individualDebtIndex" }, "processResult": { "type": "integer", "format": "int32", "x-aura-field-code": "processResult" }, "referenceNumber": { "type": "string", "x-aura-field-code": "referenceNumber" }, "requestTime": { "type": "string", "format": "date-time", "x-aura-field-code": "requestTime" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what 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-individual-query-internal", "x-aura-domain": "integration", "x-aura-raw-url-path": "credit-bureau-infos/individual-queries/internal/by-citizenid/{citizenId}", "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": "GetIndividualQueryInternalDto", "payload": "GetIndividualQueryInternalDto", "collection": false, "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." } } }, "/credit-bureau-infos/individual-queries/manipulated/by-citizenid/{citizenId}": { "get": { "operationId": "get-manipulated-risk-report-data", "tags": [ "credit-bureau-infos" ], "summary": "get-manipulated-risk-report-data", "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": { "externalServiceResultId": { "type": "string", "format": "uuid", "x-aura-field-code": "externalServiceResultId" }, "kbkReasonNonScoring": { "type": "string", "x-aura-field-code": "kbkReasonNonScoring" }, "kkb1StAccTOpenDateDif": { "type": "integer", "format": "int32", "x-aura-field-code": "kkb1StAccTOpenDateDif" }, "kkb1StccOpenDateDif": { "type": "integer", "format": "int32", "x-aura-field-code": "kkb1StccOpenDateDif" }, "kkbAcctCntUpdL6M": { "type": "integer", "format": "int32", "x-aura-field-code": "kkbAcctCntUpdL6M" }, "kkbAfterLitDefRec": { "type": "integer", "format": "int32", "x-aura-field-code": "kkbAfterLitDefRec" }, "kkbAllAcctLastUpdDt": { "type": "string", "format": "date", "x-aura-field-code": "kkbAllAcctLastUpdDt" }, "kkbAllCurrentWps": { "type": "string", "x-aura-field-code": "kkbAllCurrentWps" }, "kkbAllGt1DqL6MGt4Rec": { "type": "integer", "format": "int32", "x-aura-field-code": "kkbAllGt1DqL6MGt4Rec" }, "kkbAllGt2DqL6MGt3Rec": { "type": "integer", "format": "int32", "x-aura-field-code": "kkbAllGt2DqL6MGt3Rec" }, "kkbAllGt3DqL6MGt2Rec": { "type": "integer", "format": "int32", "x-aura-field-code": "kkbAllGt3DqL6MGt2Rec" }, "kkbAllRecOpenedL1W": { "type": "integer", "format": "int32", "x-aura-field-code": "kkbAllRecOpenedL1W" }, "kkbAllRecOpenedL24M": { "type": "integer", "format": "int32", "x-aura-field-code": "kkbAllRecOpenedL24M" }, "kkbAllRecOpenedLm": { "type": "integer", "format": "int32", "x-aura-field-code": "kkbAllRecOpenedLm" }, "kkbAllWpsL12M": { "type": "string", "x-aura-field-code": "kkbAllWpsL12M" }, "kkbAllWpsL18M": { "type": "string", "x-aura-field-code": "kkbAllWpsL18M" }, "kkbAllWpsL3M": { "type": "string", "x-aura-field-code": "kkbAllWpsL3M" }, "kkbAllWpsL6M": { "type": "string", "x-aura-field-code": "kkbAllWpsL6M" }, "kkbBbe": { "type": "string", "x-aura-field-code": "kkbBbe" }, "kkbBureauScore": { "type": "string", "x-aura-field-code": "kkbBureauScore" }, "kkbCcAcctCnt": { "type": "integer", "format": "int32", "x-aura-field-code": "kkbCcAcctCnt" }, "kkbCcDelqAcctCnt": { "type": "integer", "format": "int32", "x-aura-field-code": "kkbCcDelqAcctCnt" }, "kkbCcDelqAcctWps": { "type": "string", "x-aura-field-code": "kkbCcDelqAcctWps" }, "kkbCcOpenMaxLim": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbCcOpenMaxLim" }, "kkbCcOpenSecondMaxLim": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbCcOpenSecondMaxLim" }, "kkbCcOpenTotLim": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbCcOpenTotLim" }, "kkbCcOpenTotPay": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbCcOpenTotPay" }, "kkbCcOpenTotRisk": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbCcOpenTotRisk" }, "kkbCcOvrDueOutsTotAmt": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbCcOvrDueOutsTotAmt" }, "kkbCcOvrDueTotAmt": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbCcOvrDueTotAmt" }, "kkbCcUtilRatio": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbCcUtilRatio" }, "kkbClosedDefAmtL12M": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbClosedDefAmtL12M" }, "kkbClosedDefAmtL24M": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbClosedDefAmtL24M" }, "kkbClosedDefRecL12M": { "type": "integer", "format": "int32", "x-aura-field-code": "kkbClosedDefRecL12M" }, "kkbClosedDefRecL24M": { "type": "integer", "format": "int32", "x-aura-field-code": "kkbClosedDefRecL24M" }, "kkbD1AcctCntL3M": { "type": "integer", "format": "int32", "x-aura-field-code": "kkbD1AcctCntL3M" }, "kkbD2AcctCntL12M": { "type": "integer", "format": "int32", "x-aura-field-code": "kkbD2AcctCntL12M" }, "kkbD2AcctCntL6M": { "type": "integer", "format": "int32", "x-aura-field-code": "kkbD2AcctCntL6M" }, "kkbD3AcctCntL12M": { "type": "integer", "format": "int32", "x-aura-field-code": "kkbD3AcctCntL12M" }, "kkbD3AcctCntL6M": { "type": "integer", "format": "int32", "x-aura-field-code": "kkbD3AcctCntL6M" }, "kkbDelqAcctCnt": { "type": "integer", "format": "int32", "x-aura-field-code": "kkbDelqAcctCnt" }, "kkbErrorFlag": { "type": "string", "x-aura-field-code": "kkbErrorFlag" }, "kkbFlag": { "type": "boolean", "x-aura-field-code": "kkbFlag" }, "kkbGrtd1AcctCntL3M": { "type": "integer", "format": "int32", "x-aura-field-code": "kkbGrtd1AcctCntL3M" }, "kkbGrtd2AcctCntL12M": { "type": "integer", "format": "int32", "x-aura-field-code": "kkbGrtd2AcctCntL12M" }, "kkbGrtd2AcctCntL6M": { "type": "integer", "format": "int32", "x-aura-field-code": "kkbGrtd2AcctCntL6M" }, "kkbHlDelqAcctWps": { "type": "string", "x-aura-field-code": "kkbHlDelqAcctWps" }, "kkbHlOvrDueOutsTotAmt": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbHlOvrDueOutsTotAmt" }, "kkbHlOvrDueTotAmt": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbHlOvrDueTotAmt" }, "kkbLoanOpenInstMaxAmnt": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbLoanOpenInstMaxAmnt" }, "kkbLoanOpenInstMaxAmntWps1L3M": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbLoanOpenInstMaxAmntWps1L3M" }, "kkbLoanOpenInstTotAmnt": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbLoanOpenInstTotAmnt" }, "kkbLoanOpenInstTotAmntExlHl": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbLoanOpenInstTotAmntExlHl" }, "kkbLoanOpenInstTotAmntL12M": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbLoanOpenInstTotAmntL12M" }, "kkbLoanOpenInstTotAmntWps1L3M": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbLoanOpenInstTotAmntWps1L3M" }, "kkbLoanOpenTotLim": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbLoanOpenTotLim" }, "kkbLoanOpenTotLimExcHl": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbLoanOpenTotLimExcHl" }, "kkbLoanOpenTotPay": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbLoanOpenTotPay" }, "kkbLoanOpenTotPayWps1L12M": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbLoanOpenTotPayWps1L12M" }, "kkbLoanOpenTotPayWps1L3M": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbLoanOpenTotPayWps1L3M" }, "kkbLoanOpenTotRisk": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbLoanOpenTotRisk" }, "kkbLoanOpenTotRiskExlHl": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbLoanOpenTotRiskExlHl" }, "kkbLoanOpenWps1MaxLimExcHlL24M": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbLoanOpenWps1MaxLimExcHlL24M" }, "kkbLoanOpenWps1MaxLimExcHlL6M": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbLoanOpenWps1MaxLimExcHlL6M" }, "kkbLoanOpenWps1MaxLimL24M": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbLoanOpenWps1MaxLimL24M" }, "kkbOdDelqAcctWps": { "type": "string", "x-aura-field-code": "kkbOdDelqAcctWps" }, "kkbOdOpenMaxLim": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbOdOpenMaxLim" }, "kkbOdOpenTotLim": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbOdOpenTotLim" }, "kkbOdOpenTotPay": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbOdOpenTotPay" }, "kkbOdOpenTotRisk": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbOdOpenTotRisk" }, "kkbOdOvrDueOutsTotAmt": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbOdOvrDueOutsTotAmt" }, "kkbOdOvrDueTotAmt": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbOdOvrDueTotAmt" }, "kkbOdUtilRatio": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbOdUtilRatio" }, "kkbOpenCurrentDayDelqAmnt": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbOpenCurrentDayDelqAmnt" }, "kkbOpenCurrentDayWps": { "type": "string", "x-aura-field-code": "kkbOpenCurrentDayWps" }, "kkbOpenCurrentWps": { "type": "string", "x-aura-field-code": "kkbOpenCurrentWps" }, "kkbOpenDefAmnt": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbOpenDefAmnt" }, "kkbOpenDefRec": { "type": "integer", "format": "int32", "x-aura-field-code": "kkbOpenDefRec" }, "kkbOpenMicroLoanCnt": { "type": "integer", "format": "int32", "x-aura-field-code": "kkbOpenMicroLoanCnt" }, "kkbOpenWpsL18M": { "type": "string", "x-aura-field-code": "kkbOpenWpsL18M" }, "kkbOpenedDefAmtL12M": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbOpenedDefAmtL12M" }, "kkbOpenedDefAmtL24M": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbOpenedDefAmtL24M" }, "kkbOpenedDefRecL12M": { "type": "integer", "format": "int32", "x-aura-field-code": "kkbOpenedDefRecL12M" }, "kkbOpenedDefRecL24M": { "type": "integer", "format": "int32", "x-aura-field-code": "kkbOpenedDefRecL24M" }, "kkbOpenedLoanL1M": { "type": "integer", "format": "int32", "x-aura-field-code": "kkbOpenedLoanL1M" }, "kkbOpenedLoanL3M": { "type": "integer", "format": "int32", "x-aura-field-code": "kkbOpenedLoanL3M" }, "kkbOpenedPlL1MMaxLim": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbOpenedPlL1MMaxLim" }, "kkbOpenedPlL1MTotLim": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbOpenedPlL1MTotLim" }, "kkbOpenedPlL24MMaxLim": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbOpenedPlL24MMaxLim" }, "kkbOpenedPlL24MTotLim": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbOpenedPlL24MTotLim" }, "kkbOpenedPlL3MMaxLim": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbOpenedPlL3MMaxLim" }, "kkbOpenedPlL3MTotLim": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbOpenedPlL3MTotLim" }, "kkbOvrDue2ConSecL3M": { "type": "boolean", "x-aura-field-code": "kkbOvrDue2ConSecL3" }, "kkbOvrDue3ConSecL6M": { "type": "boolean", "x-aura-field-code": "kkbOvrDue3ConSecL6" }, "kkbOvrDueD2pOutsTotAmt": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbOvrDueD2pOutsTotAmt" }, "kkbOvrDueD2pTotAmt": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbOvrDueD2pTotAmt" }, "kkbOvrDueD3pOutsTotAmt": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbOvrDueD3pOutsTotAmt" }, "kkbOvrDueD3pTotAmt": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbOvrDueD3pTotAmt" }, "kkbOvrDueOutsTotAmt": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbOvrDueOutsTotAmt" }, "kkbOvrDueTotAmt": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbOvrDueTotAmt" }, "kkbPlDelqAcctWps": { "type": "string", "x-aura-field-code": "kkbPlDelqAcctWps" }, "kkbPlOvrDueOutsTotAmt": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbPlOvrDueOutsTotAmt" }, "kkbPlOvrDueTotAmt": { "type": "number", "format": "decimal", "x-aura-field-code": "kkbPlOvrDueTotAmt" }, "kkbQueryDate": { "type": "string", "format": "date", "x-aura-field-code": "kkbQueryDate" }, "kkbRefNo": { "type": "string", "x-aura-field-code": "kkbRefNo" }, "kkbTotOpenRecNum": { "type": "integer", "format": "int32", "x-aura-field-code": "kkbTotOpenRecNum" }, "kkbWpsGrt1MCntL6M": { "type": "integer", "format": "int32", "x-aura-field-code": "kkbWpsGrt1MCntL6M" }, "kkbWriteOffOpenRecFlg": { "type": "boolean", "x-aura-field-code": "kkbWriteOffOpenRecFlg" }, "kkbWriteOffRecFlg": { "type": "boolean", "x-aura-field-code": "kkbWriteOffRecFlg" }, "kkbWriteOffRecL5Yflg": { "type": "boolean", "x-aura-field-code": "kkbWriteOffRecL5Yflg" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what 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-manipulated-risk-report-data", "x-aura-domain": "integration", "x-aura-raw-url-path": "credit-bureau-infos/individual-queries/manipulated/by-citizenid/{citizenId}", "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": "GetManipulatedRiskReportDataDto", "payload": "GetManipulatedRiskReportDataDto", "collection": false, "members": [ { "name": "ExternalServiceResultId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "KkbRefNo", "declared_type": "string", "nullable": false, "collection": false }, { "name": "KkbQueryDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "KkbFlag", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "KkbErrorFlag", "declared_type": "string", "nullable": false, "collection": false }, { "name": "KkbBureauScore", "declared_type": "string", "nullable": false, "collection": false }, { "name": "KbkReasonNonScoring", "declared_type": "string", "nullable": false, "collection": false }, { "name": "KkbBbe", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Kkb1StAccTOpenDateDif", "declared_type": "int", "nullable": false, "collection": false }, { "name": "KkbAllAcctLastUpdDt", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "KkbAcctCntUpdL6M", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Kkb1StccOpenDateDif", "declared_type": "int", "nullable": false, "collection": false }, { "name": "KkbCcDelqAcctCnt", "declared_type": "int", "nullable": false, "collection": false }, { "name": "KkbCcDelqAcctWps", "declared_type": "string", "nullable": false, "collection": false }, { "name": "KkbPlDelqAcctWps", "declared_type": "string", "nullable": false, "collection": false }, { "name": "KkbOdDelqAcctWps", "declared_type": "string", "nullable": false, "collection": false }, { "name": "KkbHlDelqAcctWps", "declared_type": "string", "nullable": false, "collection": false }, { "name": "KkbAllCurrentWps", "declared_type": "string", "nullable": false, "collection": false }, { "name": "KkbOpenCurrentDayWps", "declared_type": "string", "nullable": false, "collection": false }, { "name": "KkbOpenCurrentDayDelqAmnt", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbAllWpsL3M", "declared_type": "string", "nullable": false, "collection": false }, { "name": "KkbAllWpsL6M", "declared_type": "string", "nullable": false, "collection": false }, { "name": "KkbAllWpsL12M", "declared_type": "string", "nullable": false, "collection": false }, { "name": "KkbAllWpsL18M", "declared_type": "string", "nullable": false, "collection": false }, { "name": "KkbAllGt2DqL6MGt3Rec", "declared_type": "int", "nullable": false, "collection": false }, { "name": "KkbAllGt3DqL6MGt2Rec", "declared_type": "int", "nullable": false, "collection": false }, { "name": "KkbAllGt1DqL6MGt4Rec", "declared_type": "int", "nullable": false, "collection": false }, { "name": "KkbD1AcctCntL3M", "declared_type": "int", "nullable": false, "collection": false }, { "name": "KkbGrtd1AcctCntL3M", "declared_type": "int", "nullable": false, "collection": false }, { "name": "KkbD2AcctCntL6M", "declared_type": "int", "nullable": false, "collection": false }, { "name": "KkbD3AcctCntL6M", "declared_type": "int", "nullable": false, "collection": false }, { "name": "KkbGrtd2AcctCntL6M", "declared_type": "int", "nullable": false, "collection": false }, { "name": "KkbD2AcctCntL12M", "declared_type": "int", "nullable": false, "collection": false }, { "name": "KkbD3AcctCntL12M", "declared_type": "int", "nullable": false, "collection": false }, { "name": "KkbGrtd2AcctCntL12M", "declared_type": "int", "nullable": false, "collection": false }, { "name": "KkbClosedDefRecL12M", "declared_type": "int", "nullable": false, "collection": false }, { "name": "KkbOpenedDefRecL12M", "declared_type": "int", "nullable": false, "collection": false }, { "name": "KkbClosedDefAmtL12M", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbOpenedDefAmtL12M", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbClosedDefRecL24M", "declared_type": "int", "nullable": false, "collection": false }, { "name": "KkbOpenedDefRecL24M", "declared_type": "int", "nullable": false, "collection": false }, { "name": "KkbClosedDefAmtL24M", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbOpenedDefAmtL24M", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbWriteOffRecFlg", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "KkbWriteOffOpenRecFlg", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "KkbWriteOffRecL5Yflg", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "KkbAfterLitDefRec", "declared_type": "int", "nullable": false, "collection": false }, { "name": "KkbAllRecOpenedL1W", "declared_type": "int", "nullable": false, "collection": false }, { "name": "KkbAllRecOpenedLm", "declared_type": "int", "nullable": false, "collection": false }, { "name": "KkbOpenedLoanL1M", "declared_type": "int", "nullable": false, "collection": false }, { "name": "KkbOpenedLoanL3M", "declared_type": "int", "nullable": false, "collection": false }, { "name": "KkbOpenedPlL1MTotLim", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbOpenedPlL3MTotLim", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbOpenedPlL24MTotLim", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbOpenedPlL1MMaxLim", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbOpenedPlL3MMaxLim", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbOpenedPlL24MMaxLim", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbCcOvrDueTotAmt", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbPlOvrDueTotAmt", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbHlOvrDueTotAmt", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbOdOvrDueTotAmt", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbOvrDueOutsTotAmt", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbCcOvrDueOutsTotAmt", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbPlOvrDueOutsTotAmt", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbHlOvrDueOutsTotAmt", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbOdOvrDueOutsTotAmt", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbOvrDueD2pTotAmt", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbOvrDueD2pOutsTotAmt", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbOvrDueD3pTotAmt", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbOvrDueD3pOutsTotAmt", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbLoanOpenTotLim", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbLoanOpenInstTotAmnt", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbLoanOpenInstTotAmntL12M", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbLoanOpenInstMaxAmnt", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbLoanOpenTotRisk", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbLoanOpenTotLimExcHl", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbLoanOpenInstTotAmntExlHl", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbLoanOpenTotRiskExlHl", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbCcOpenTotLim", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbCcOpenTotRisk", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbCcOpenTotPay", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbCcOpenMaxLim", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbCcOpenSecondMaxLim", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbCcUtilRatio", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbOdOpenTotLim", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbOdOpenTotRisk", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbOdOpenTotPay", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbOdUtilRatio", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbCcAcctCnt", "declared_type": "int", "nullable": false, "collection": false }, { "name": "KkbOpenWpsL18M", "declared_type": "string", "nullable": false, "collection": false }, { "name": "KkbAllRecOpenedL24M", "declared_type": "int", "nullable": false, "collection": false }, { "name": "KkbWpsGrt1MCntL6M", "declared_type": "int", "nullable": false, "collection": false }, { "name": "KkbOvrDue2ConSecL3M", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "KkbOvrDue3ConSecL6M", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "KkbLoanOpenWps1MaxLimL24M", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbLoanOpenInstTotAmntWps1L3M", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbLoanOpenInstMaxAmntWps1L3M", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbLoanOpenTotPay", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbLoanOpenTotPayWps1L12M", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbLoanOpenTotPayWps1L3M", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbOpenMicroLoanCnt", "declared_type": "int", "nullable": false, "collection": false }, { "name": "KkbLoanOpenWps1MaxLimExcHlL24M", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbLoanOpenWps1MaxLimExcHlL6M", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbOdOpenMaxLim", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbTotOpenRecNum", "declared_type": "int", "nullable": false, "collection": false }, { "name": "KkbDelqAcctCnt", "declared_type": "int", "nullable": false, "collection": false }, { "name": "KkbOpenCurrentWps", "declared_type": "string", "nullable": false, "collection": false }, { "name": "KkbOpenDefRec", "declared_type": "int", "nullable": false, "collection": false }, { "name": "KkbOpenDefAmnt", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "KkbOvrDueTotAmt", "declared_type": "decimal", "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_17", "status": 400, "message": { "ar": "لا يمكن العثور على رقم المواطن.", "en": "Citizen Number cannot be found.", "tr": "Vatandaşlık numarası bulunamadı." }, "message_available": true, "constant_name": "CITIZEN_NUMBER_NOT_FOUND" } ] } } }, "/credit-bureau-infos/refresh-token-for-risk-center": { "post": { "operationId": "refresh-credit-bureau-token", "tags": [ "credit-bureau-infos" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "refresh-credit-bureau-token", "description": "Invokes the `refresh-credit-bureau-token` service definition through `POST /credit-bureau-infos/refresh-token-for-risk-center`.", "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. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "refresh-credit-bureau-token", "x-aura-domain": "integration", "x-aura-raw-url-path": "credit-bureau-infos/refresh-token-for-risk-center", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "RefreshToken", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "CreateCreditBureauTokenDto", "payload": "CreateCreditBureauTokenDto", "collection": false, "members": [ { "name": "AccessToken", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TokenType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExpireIn", "declared_type": "int", "nullable": false, "collection": false }, { "name": "RefreshToken", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Scope", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/data-migrations": { "get": { "operationId": "integration-get-data-migration-list", "tags": [ "data-migrations" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "Returns data migration records", "description": "Invokes the `integration-get-data-migration-list` service definition through `GET /data-migrations`.\n\nTurkish display name: Data migration listesini döner", "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. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "integration-get-data-migration-list", "x-aura-domain": "integration", "x-aura-raw-url-path": "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": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "List", "envelopes": [ "List" ], "payload": "DataMigrationDto", "collection": true, "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." } } }, "/dgpara-wallets/access-token": { "post": { "operationId": "create-dg-para-wallet-token", "tags": [ "dgpara-wallets" ], "summary": "create-dg-para-wallet-token", "x-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": "create-dg-para-wallet-token", "x-aura-domain": "integration", "x-aura-raw-url-path": "dgpara-wallets/access-token", "x-aura-request-contract": { "state": "no-members" }, "x-aura-code-response": { "state": "structure", "declared_type": "CreateDgParaWalletTokenDto", "payload": "CreateDgParaWalletTokenDto", "collection": false, "members": [ { "name": "AccessToken", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExpireIn", "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 single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/dgpara-wallets/installment-payment": { "post": { "operationId": "installment-debt-payment", "tags": [ "dgpara-wallets" ], "summary": "installment-debt-payment", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "borrowerChannelId": { "type": "integer", "format": "int32", "x-aura-field-code": "borrowerChannelId" }, "citizenId": { "type": "string", "x-aura-field-code": "citizenId" }, "description": { "type": "string", "x-aura-field-code": "description" }, "transactionAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "transactionAmount" } }, "required": [ "borrowerChannelId", "citizenId", "description", "transactionAmount" ] } } } }, "x-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": "installment-debt-payment", "x-aura-domain": "integration", "x-aura-raw-url-path": "dgpara-wallets/installment-payment", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CitizenId", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "BorrowerChannelId", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ExternalServiceResultDto", "envelopes": [ "ExternalServiceResultDto" ], "payload": "InstallmentDebtPaymentDto", "collection": false, "members": [ { "name": "ResponseCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ResponseMessage", "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 } } }, "/dms/import": { "post": { "operationId": "import-dms-model", "tags": [ "dms" ], "summary": "import-dms-model", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "content": { "type": "string", "x-aura-field-code": "content" }, "fileName": { "type": "string", "x-aura-field-code": "fileName" } }, "required": [ "content", "fileName" ] } } } }, "x-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. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "import-dms-model", "x-aura-domain": "integration", "x-aura-raw-url-path": "dms/import", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Content", "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" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is 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_32", "status": 400, "message": null, "message_available": false, "constant_name": "DMS_CONNECTION_ERROR" } ] } } }, "/easy-addresses": { "delete": { "operationId": "delete-easy-address-definition", "tags": [ "easy-addresses" ], "summary": "delete-easy-address-definition", "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": "transactionid", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "transactionid" } } ], "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": 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": "delete-easy-address-definition", "x-aura-domain": "integration", "x-aura-raw-url-path": "easy-addresses", "x-aura-request-contract": { "state": "no-members" }, "x-aura-code-response": { "state": "structure", "declared_type": "ExternalServiceResultDto", "envelopes": [ "ExternalServiceResultDto" ], "payload": "DeleteEasyAddressDto", "collection": false, "members": [ { "name": "IsSuccess", "declared_type": "bool", "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 } }, "put": { "operationId": "update-easy-address-definition", "tags": [ "easy-addresses" ], "summary": "update-easy-address-definition", "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" }, "oldAddressType": { "type": "string", "x-aura-field-code": "oldAddressType" }, "oldAddressValue": { "type": "string", "x-aura-field-code": "oldAddressValue" }, "transactionid": { "type": "string", "x-aura-field-code": "transactionid" } }, "required": [ "addressType", "addressValue", "channelCode", "customerTitle", "customerType", "description", "iban", "oldAddressType", "oldAddressValue", "transactionid" ] } } } }, "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": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row'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": "update-easy-address-definition", "x-aura-domain": "integration", "x-aura-raw-url-path": "easy-addresses", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "OldAddressType", "declared_type": null, "nullable": false, "collection": false }, { "name": "OldAddressValue", "declared_type": null, "nullable": false, "collection": false }, { "name": "Iban", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerType", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerTitle", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChannelCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false } ] }, "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 } } }, "/easy-addresses/moved": { "get": { "operationId": "get-moved-address", "tags": [ "easy-addresses" ], "summary": "get-moved-address", "parameters": [ { "name": "transactionEndDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time", "x-aura-field-code": "transactionEndDate" } }, { "name": "transactionStartDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time", "x-aura-field-code": "transactionStartDate" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "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": "get-moved-address", "x-aura-domain": "integration", "x-aura-raw-url-path": "easy-addresses/moved", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "TransactionStartDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionEndDate", "declared_type": null, "nullable": false, "collection": false } ] }, "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 } } }, "/easy-addresses/receiver": { "get": { "operationId": "get-easy-address-receiver", "tags": [ "easy-addresses" ], "summary": "get-easy-address-receiver", "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": "fromIdentityNumber", "in": "query", "required": false, "schema": { "x-aura-type": "unresolved" } }, { "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": 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. 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": "get-easy-address-receiver", "x-aura-domain": "integration", "x-aura-raw-url-path": "easy-addresses/receiver", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "FromIdentityNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionId", "declared_type": null, "nullable": false, "collection": false, "wire_name": "transactionid", "wire_name_basis": "declared" } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ExternalServiceResultDto", "envelopes": [ "ExternalServiceResultDto" ], "payload": "EasyAddressReceiverDto", "collection": false, "members": [ { "name": "Owner", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Iban", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MaskedIban", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerTitle", "declared_type": "string", "nullable": false, "collection": false }, { "name": "QueryRef", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OwnerMasked", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerTitleMasked", "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-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" } ] } } }, "/email-attachment-notifications/send": { "post": { "operationId": "send-email-attachment", "tags": [ "email-attachment-notifications" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "send-email-attachment", "description": "Invokes the `send-email-attachment` service definition through `POST /email-attachment-notifications/send`.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "body": { "type": "string", "x-aura-field-code": "email_body" }, "customerNumber": { "type": "string", "x-aura-field-code": "CustomerNumber" }, "documentItemCode": { "type": "string", "x-aura-field-code": "documentItemCode" }, "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", "customerNumber", "documentItemCode", "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": 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. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what 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-email-attachment", "x-aura-domain": "integration", "x-aura-raw-url-path": "email-attachment-notifications/send", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CustomerNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "DocumentItemCode", "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": "Error", "status": 400, "message": null, "message_available": false, "constant_name": null } ] } } }, "/email-multi-attachment-notifications/send": { "post": { "operationId": "send-email-multi-attachment", "tags": [ "email-multi-attachment-notifications" ], "summary": "send-email-multi-attachment", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "body": { "type": "string", "x-aura-field-code": "email_body" }, "customerNumber": { "type": "string", "x-aura-field-code": "CustomerNumber" }, "documentItemCodes": { "type": "array", "items": { "type": "string", "x-aura-field-code": "documentItemCodes" } }, "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", "customerNumber", "documentItemCodes", "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": 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. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what 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-email-multi-attachment", "x-aura-domain": "integration", "x-aura-raw-url-path": "email-multi-attachment-notifications/send", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CustomerNumber", "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": "Error", "status": 400, "message": null, "message_available": false, "constant_name": null } ] } } }, "/enqura-qualify/access-token": { "post": { "operationId": "create-enqura-qualify-token", "tags": [ "enqura-qualify" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "Create Enqura Qualify Token", "description": "Invokes the `create-enqura-qualify-token` service definition through `POST /enqura-qualify/access-token`.", "x-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": "create-enqura-qualify-token", "x-aura-domain": "integration", "x-aura-raw-url-path": "enqura-qualify/access-token", "x-aura-request-contract": { "state": "no-members" }, "x-aura-code-response": { "state": "structure", "declared_type": "CreateEnquraQualifyTokenDto", "payload": "CreateEnquraQualifyTokenDto", "collection": false, "members": [ { "name": "IsSuccessful", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "ReferenceId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Token", "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 } } }, "/enqura-qualify/sessions": { "post": { "operationId": "session-qualify", "tags": [ "enqura-qualify" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "Session Qualify", "description": "Invokes the `session-qualify` service definition through `POST /enqura-qualify/sessions`.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "loadContent": { "type": "boolean", "x-aura-field-code": "loadContent" }, "loadDetails": { "type": "boolean", "x-aura-field-code": "loadDetails" }, "sessionUId": { "type": "string", "x-aura-field-code": "sessionUId" } }, "required": [ "loadContent", "loadDetails", "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": 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": "session-qualify", "x-aura-domain": "integration", "x-aura-raw-url-path": "enqura-qualify/sessions", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "SessionUId", "declared_type": null, "nullable": false, "collection": false }, { "name": "LoadDetails", "declared_type": null, "nullable": false, "collection": false }, { "name": "LoadContent", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ExternalServiceResultDto", "envelopes": [ "ExternalServiceResultDto" ], "payload": "GetEnquraQualifySessionDto", "collection": false, "members": [ { "name": "IsSuccessful", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "Email", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Citizenid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Phone", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CallType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReferenceId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "PartnerCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FaceResult", "declared_type": "int", "nullable": false, "collection": false }, { "name": "OcrResult", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "NfcResult", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "EnquraResult", "declared_type": "string", "nullable": false, "collection": false }, { "name": "EnquraReference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Consents", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Occupations", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Incomes", "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 } } }, "/exchange-rates": { "get": { "operationId": "get-exchange-rate-list", "tags": [ "exchange-rates" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "get-exchange-rate-list", "description": "Invokes the `get-exchange-rate-list` service definition through `GET /exchange-rates`.", "parameters": [ { "name": "bidAsk", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "bidAsk" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "x-aura-field-code": "exchangeRateEndDate" } }, { "name": "serviceDefinitionId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "serviceDefinitionId" } }, { "name": "sourceCurrency", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "sourceCurrency" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "x-aura-field-code": "exchangeRateStartDate" } }, { "name": "targetCurrencies", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "x-aura-field-code": "targetCurrencies" } } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "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. 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": { "dataSourceType": { "type": "integer", "format": "int32", "x-aura-field-code": "dataSourceType" }, "externalServiceResult": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "x-aura-field-code": "exchangeRateDate" }, "exchangeInfos": { "type": "array", "items": { "type": "object", "properties": { "bidAsk": { "type": "string", "x-aura-field-code": "bidAsk" }, "code": { "type": "string", "x-aura-field-code": "tcmbExchangeCode", "x-aura-encrypted": true }, "exchangeRate": { "type": "number", "format": "decimal", "x-aura-field-code": "exchangeRate" } }, "x-aura-field-code": "exchangeInfos" } } }, "x-aura-field-code": "tcmbExternalServiceResult" } }, "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": "get-exchange-rate-list", "x-aura-domain": "integration", "x-aura-raw-url-path": "exchange-rates", "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": "ServiceDefinitionId", "declared_type": null, "nullable": true, "collection": false }, { "name": "SourceCurrency", "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": "BidAsk", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "The repository declares `ExchangeRateDto` 2 times and nothing in the route expression says which one. No structure is published rather than one picked at random.", "declared_type": "ExternalServiceResultDto>", "envelopes": [ "ExternalServiceResultDto", "IEnumerable" ], "payload": "ExchangeRateDto" } } }, "/external-service-results/unproccessed-virtual-iban-results": { "get": { "operationId": "get-unproccessed-virtual-iban-result-list", "tags": [ "external-service-results" ], "summary": "get-unproccessed-virtual-iban-result-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" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "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": { "dataSourceType": { "type": "integer", "format": "int32", "x-aura-field-code": "dataSourceType" }, "externalServiceResult": { "type": "object", "properties": { "incomingTransactionList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "comment": { "type": "string", "x-aura-field-code": "comment" }, "creditCardNumber": { "type": "string", "x-aura-field-code": "creditCardNumber" }, "fECId": { "type": "string", "x-aura-field-code": "fECId" }, "gibTransferType": { "type": "integer", "format": "int32", "x-aura-field-code": "gibTransferType" }, "queryToken": { "type": "integer", "format": "int64", "x-aura-field-code": "queryToken" }, "receiverAccountNumber": { "type": "string", "x-aura-field-code": "receiverAccountNumber" }, "receiverAddress": { "type": "string", "x-aura-field-code": "receiverAddress" }, "receiverFatherName": { "type": "string", "x-aura-field-code": "receiverFatherName" }, "receiverNameSurname": { "type": "string", "x-aura-field-code": "receiverNameSurname" }, "receiverPhoneNumber": { "type": "string", "x-aura-field-code": "receiverPhoneNumber" }, "receiverTaxNumber": { "type": "string", "x-aura-field-code": "receiverTaxNumber" }, "senderAccountNumber": { "type": "string", "x-aura-field-code": "senderAccountNumber" }, "senderAddress": { "type": "string", "x-aura-field-code": "senderAddress" }, "senderBankCode": { "type": "integer", "format": "int32", "x-aura-field-code": "senderBankCode" }, "senderBirthDate": { "type": "string", "x-aura-field-code": "senderBirthDate" }, "senderBirthPlace": { "type": "string", "x-aura-field-code": "senderBirthPlace" }, "senderBranchCode": { "type": "integer", "format": "int32", "x-aura-field-code": "senderBranchCode" }, "senderCustomerId": { "type": "string", "x-aura-field-code": "senderCustomerId" }, "senderNameSurname": { "type": "string", "x-aura-field-code": "senderNameSurname" }, "senderPassportNumber": { "type": "string", "x-aura-field-code": "senderPassportNumber" }, "senderPhoneNumber": { "type": "string", "x-aura-field-code": "senderPhoneNumber" }, "senderTaxNumber": { "type": "string", "x-aura-field-code": "senderTaxNumber" }, "tranDateWithTime": { "type": "string", "format": "date-time", "x-aura-field-code": "tranDateWithTime" }, "transactionCode": { "type": "string", "x-aura-field-code": "transactionCode" }, "transactionGuidId": { "type": "integer", "format": "int32", "x-aura-field-code": "transactionGuidId" } }, "x-aura-field-code": "incomingTransactionList" } }, "queryDate": { "type": "string", "format": "date-time", "x-aura-field-code": "queryDate" }, "queryPackageId": { "type": "integer", "format": "int32", "x-aura-field-code": "queryPackageId" }, "success": { "type": "boolean", "x-aura-field-code": "success" } }, "x-aura-field-code": "externalServiceResult" }, "externalServiceResultId": { "type": "string", "format": "uuid", "x-aura-field-code": "externalServiceResultId" }, "retryCount": { "type": "integer", "format": "int32", "x-aura-field-code": "retryCount" }, "virtualIbanResultId": { "type": "string", "format": "uuid", "x-aura-field-code": "virtualIbanResultId" } } }, "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-unproccessed-virtual-iban-result-list", "x-aura-domain": "integration", "x-aura-raw-url-path": "external-service-results/unproccessed-virtual-iban-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-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 route's response type `IEnumerable>` was not reduced to a single payload.", "declared_type": "IEnumerable>", "envelopes": [ "IEnumerable" ] } } }, "/external-services": { "get": { "operationId": "get-external-service-definition-list", "tags": [ "external-services" ], "summary": "get-external-service-definition-list", "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" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "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 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": { "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" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "externalServiceDefinitionId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "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" } } }, "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-external-service-definition-list", "x-aura-domain": "integration", "x-aura-raw-url-path": "external-services", "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": "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." } } }, "/external-services/by-service-definition-id/{serviceDefinitionId}": { "get": { "operationId": "get-external-service-definition-by-service-definition-id", "tags": [ "external-services" ], "summary": "get-external-service-definition-by-service-definition-id", "parameters": [ { "name": "serviceDefinitionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "serviceDefinitionId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "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": "get-external-service-definition-by-service-definition-id", "x-aura-domain": "integration", "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." }, "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_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/by-service-definition-id/{serviceDefinitionId}/results/{resultId}": { "get": { "operationId": "get-external-service-result-by-id", "tags": [ "external-services" ], "summary": "get-external-service-result-by-id", "parameters": [ { "name": "serviceDefinitionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "serviceDefinitionId" } }, { "name": "resultId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "resultId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "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": { "externalServiceDefinitionId": { "type": "string", "format": "uuid", "x-aura-field-code": "externalServiceDefinitionId" }, "requestMessage": { "type": "string", "x-aura-field-code": "requestMessage" }, "requestTime": { "type": "string", "format": "date-time", "x-aura-field-code": "requestTime" }, "responseMessage": { "type": "string", "x-aura-field-code": "responseMessage" }, "responseStatus": { "type": "string", "x-aura-field-code": "responseStatus" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what 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-external-service-result-by-id", "x-aura-domain": "integration", "x-aura-raw-url-path": "external-services/by-service-definition-id/{serviceDefinitionId}/results/{resultId}", "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/external-services/{id}": { "get": { "operationId": "get-external-service-definition-by-id", "tags": [ "external-services" ], "summary": "get-external-service-definition-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "externalServiceDefinitionId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "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": "get-external-service-definition-by-id", "x-aura-domain": "integration", "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." }, "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_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": "update-external-service-definition", "tags": [ "external-services" ], "summary": "update-external-service-definition", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "externalServiceDefinitionId" } } ], "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" } ] } }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "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", "isActive", "serviceDefinitionId", "url" ] } } } }, "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": "update-external-service-definition", "x-aura-domain": "integration", "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": "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" }, { "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" } ] } } }, "/external-services/{id}/results": { "post": { "operationId": "create-external-service-result", "tags": [ "external-services" ], "summary": "create-external-service-result", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "externalServiceDefinitionId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "citizenNumber": { "type": "string", "x-aura-field-code": "citizenNumber" }, "citizenNumberType": { "type": "string", "x-aura-field-code": "externalServiceResultCitizenNumberType" }, "requestMessage": { "type": "string", "x-aura-field-code": "requestMessage" }, "requestTime": { "type": "string", "format": "date-time", "x-aura-field-code": "requestTime" }, "responseMessage": { "type": "string", "x-aura-field-code": "responseMessage" }, "responseStatus": { "type": "string", "x-aura-field-code": "responseStatus" } }, "required": [ "citizenNumber", "citizenNumberType", "requestMessage", "requestTime", "responseMessage", "responseStatus" ] } } } }, "x-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": 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": "externalServiceResultId" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "externalServiceResultId" } } }, "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": "externalServiceResultId" } } }, "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": "create-external-service-result", "x-aura-domain": "integration", "x-aura-raw-url-path": "external-services/{id}/results", "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/external-services/{id}/usage": { "get": { "operationId": "has-external-service-usage", "tags": [ "external-services" ], "summary": "has-external-service-usage", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "externalServiceDefinitionId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "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": "has-external-service-usage", "x-aura-domain": "integration", "x-aura-raw-url-path": "external-services/{id}/usage", "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": "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" } } }, "/file-storages": { "get": { "operationId": "get-file-storage-list", "tags": [ "file-storages" ], "summary": "get-file-storage-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" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "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": { "connectionString": { "type": "string", "x-aura-field-code": "connectionString", "x-aura-maskable": true }, "description": { "type": "string", "x-aura-field-code": "description" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "fileTransferId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "name": { "type": "string", "x-aura-field-code": "name", "x-aura-maskable": true }, "protocolType": { "type": "integer", "format": "int32", "x-aura-field-code": "protocolType" } } }, "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-file-storage-list", "x-aura-domain": "integration", "x-aura-raw-url-path": "file-storages", "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": "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." } }, "post": { "operationId": "create-file-storage", "tags": [ "file-storages" ], "summary": "create-file-storage", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "connectionString": { "type": "string", "x-aura-field-code": "connectionString", "x-aura-maskable": true }, "description": { "type": "string", "x-aura-field-code": "description" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "name": { "type": "string", "x-aura-field-code": "name", "x-aura-maskable": true }, "protocolType": { "type": "integer", "format": "int32", "x-aura-field-code": "protocolType", "x-aura-parameter-enumeration": { "state": "resolved", "parameter": "protocol_type", "values": [ { "value": 5, "name": "MinIO" }, { "value": 7, "name": "FTP/SFTP", "labels": { "en": "FTP/SFTP" } }, { "value": 3, "name": "Azure" }, { "value": 4, "name": "AWS S3" } ] } } }, "required": [ "connectionString", "description", "isActive", "name", "protocolType" ] } } } }, "x-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. 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": "create-file-storage", "x-aura-domain": "integration", "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 }, "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_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": "delete-file-storage", "tags": [ "file-storages" ], "summary": "delete-file-storage", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "fileStorageId" } } ], "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": "delete-file-storage", "x-aura-domain": "integration", "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" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is 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": "get-file-storage-by-id", "tags": [ "file-storages" ], "summary": "get-file-storage-by-id", "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 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": { "connectionString": { "type": "string", "x-aura-field-code": "connectionString", "x-aura-maskable": true }, "description": { "x-aura-type": "unresolved" }, "id": { "x-aura-type": "unresolved" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "name": { "x-aura-type": "unresolved" }, "protocolType": { "type": "integer", "format": "int32", "x-aura-field-code": "protocolType" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what 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-file-storage-by-id", "x-aura-domain": "integration", "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." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is 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": "update-file-storage", "tags": [ "file-storages" ], "summary": "update-file-storage", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "fileStorageId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "connectionString": { "type": "string", "x-aura-field-code": "connectionString", "x-aura-maskable": true }, "description": { "type": "string", "x-aura-field-code": "description" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "name": { "type": "string", "x-aura-field-code": "name", "x-aura-maskable": true }, "protocolType": { "type": "integer", "format": "int32", "x-aura-field-code": "protocolType", "x-aura-parameter-enumeration": { "state": "resolved", "parameter": "protocol_type", "values": [ { "value": 5, "name": "MinIO" }, { "value": 7, "name": "FTP/SFTP", "labels": { "en": "FTP/SFTP" } }, { "value": 3, "name": "Azure" }, { "value": 4, "name": "AWS S3" } ] } } }, "required": [ "connectionString", "description", "isActive", "name", "protocolType" ] } } } }, "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. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "update-file-storage", "x-aura-domain": "integration", "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" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is 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": "get-file-transfer-list", "tags": [ "file-transfers" ], "summary": "get-file-transfer-list", "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": "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. 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": { "archiveFileStorageId": { "type": "string", "format": "uuid", "x-aura-field-code": "archiveFileStorageId" }, "archivePath": { "type": "string", "x-aura-field-code": "archivePath" }, "canArchive": { "type": "boolean", "x-aura-field-code": "canArchive" }, "code": { "type": "string", "x-aura-field-code": "code" }, "destinationFileStorageId": { "type": "string", "format": "uuid", "x-aura-field-code": "destinationFileStorageId" }, "destinationPath": { "type": "string", "x-aura-field-code": "destinationPath" }, "hasVirusScan": { "type": "boolean", "x-aura-field-code": "isZip" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "fileTransferId" }, "name": { "type": "string", "x-aura-field-code": "name", "x-aura-maskable": true }, "overwriteType": { "type": "integer", "format": "int32", "x-aura-field-code": "overwriteType" }, "sourceFileStorageId": { "type": "string", "format": "uuid", "x-aura-field-code": "sourceFileStorageId" }, "sourcePath": { "type": "string", "x-aura-field-code": "sourcePath" }, "sourcePathWildcard": { "type": "string", "x-aura-field-code": "sourcePathWildcard" } } }, "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-file-transfer-list", "x-aura-domain": "integration", "x-aura-raw-url-path": "file-transfers", "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": "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." } }, "post": { "operationId": "create-file-transfer", "tags": [ "file-transfers" ], "summary": "create-file-transfer", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "archiveFileStorageId": { "type": "string", "format": "uuid", "x-aura-field-code": "archiveFileStorageId" }, "archivePath": { "type": "string", "x-aura-field-code": "archivePath" }, "canArchive": { "type": "boolean", "x-aura-field-code": "canArchive" }, "code": { "type": "string", "x-aura-field-code": "code" }, "destinationFileStorageId": { "type": "string", "format": "uuid", "x-aura-field-code": "destinationFileStorageId" }, "destinationPath": { "type": "string", "x-aura-field-code": "destinationPath" }, "isZip": { "type": "boolean", "x-aura-field-code": "isZip" }, "name": { "type": "string", "x-aura-field-code": "name", "x-aura-maskable": true }, "overwriteType": { "type": "integer", "format": "int32", "x-aura-field-code": "overwriteType" }, "sourceFileStorageId": { "type": "string", "format": "uuid", "x-aura-field-code": "sourceFileStorageId" }, "sourcePath": { "type": "string", "x-aura-field-code": "sourcePath" }, "sourcePathWildcard": { "type": "string", "x-aura-field-code": "sourcePathWildcard" } }, "required": [ "canArchive", "code", "destinationFileStorageId", "destinationPath", "isZip", "name", "overwriteType", "sourceFileStorageId", "sourcePath", "sourcePathWildcard" ] } } } }, "x-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. 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": "create-file-transfer", "x-aura-domain": "integration", "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 }, "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 } } }, "/file-transfers/by-code/{code}": { "get": { "operationId": "get-file-transfer-by-code", "tags": [ "file-transfers" ], "summary": "get-file-transfer-by-code", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "code" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "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": { "archiveFileStorageId": { "type": "string", "format": "uuid", "x-aura-field-code": "archiveFileStorageId" }, "archivePath": { "type": "string", "x-aura-field-code": "archivePath" }, "canArchive": { "type": "boolean", "x-aura-field-code": "canArchive" }, "code": { "type": "string", "x-aura-field-code": "code" }, "destinationFileStorageId": { "type": "string", "format": "uuid", "x-aura-field-code": "destinationFileStorageId" }, "destinationPath": { "type": "string", "x-aura-field-code": "destinationPath" }, "hasVirusScan": { "type": "boolean", "x-aura-field-code": "isZip" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "fileTransferId" }, "name": { "type": "string", "x-aura-field-code": "name", "x-aura-maskable": true }, "overwriteType": { "type": "integer", "format": "int32", "x-aura-field-code": "overwriteType" }, "sourceFileStorageId": { "type": "string", "format": "uuid", "x-aura-field-code": "sourceFileStorageId" }, "sourcePath": { "type": "string", "x-aura-field-code": "sourcePath" }, "sourcePathWildcard": { "type": "string", "x-aura-field-code": "sourcePathWildcard" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what 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-file-transfer-by-code", "x-aura-domain": "integration", "x-aura-raw-url-path": "file-transfers/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": "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." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is 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" } ] } } }, "/file-transfers/by-code/{code}/execute": { "post": { "operationId": "execute-file-transfer", "tags": [ "file-transfers" ], "summary": "execute-file-transfer", "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": { "fileIdentifiers": { "type": "array", "items": { "type": "object", "x-aura-field-code": "fileIdentifiers" } }, "isFolderZip": { "type": "boolean", "x-aura-field-code": "isFolderZip" } } } } } }, "x-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. 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": { "fileTransferHistoryId": { "type": "string", "format": "uuid", "x-aura-field-code": "fileTransferHistoryId" }, "fileTransferId": { "type": "string", "format": "uuid", "x-aura-field-code": "fileTransferId" }, "transferMessage": { "type": "string", "x-aura-field-code": "message" }, "transferStatus": { "type": "string", "x-aura-field-code": "transferStatus" } } }, "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": "execute-file-transfer", "x-aura-domain": "integration", "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" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is 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": "delete-file-transfer", "tags": [ "file-transfers" ], "summary": "delete-file-transfer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "fileTransferId" } } ], "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": "delete-file-transfer", "x-aura-domain": "integration", "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" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is 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": "get-file-transfer-by-id", "tags": [ "file-transfers" ], "summary": "get-file-transfer-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "fileTransferId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "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": { "archiveFileStorageId": { "type": "string", "format": "uuid", "x-aura-field-code": "archiveFileStorageId" }, "archivePath": { "type": "string", "x-aura-field-code": "archivePath" }, "canArchive": { "type": "boolean", "x-aura-field-code": "canArchive" }, "code": { "type": "string", "x-aura-field-code": "code" }, "destinationFileStorageId": { "type": "string", "format": "uuid", "x-aura-field-code": "destinationFileStorageId" }, "destinationPath": { "type": "string", "x-aura-field-code": "destinationPath" }, "hasVirusScan": { "type": "boolean", "x-aura-field-code": "isZip" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "fileTransferId" }, "name": { "type": "string", "x-aura-field-code": "name", "x-aura-maskable": true }, "overwriteType": { "type": "integer", "format": "int32", "x-aura-field-code": "overwriteType" }, "sourceFileStorageId": { "type": "string", "format": "uuid", "x-aura-field-code": "sourceFileStorageId" }, "sourcePath": { "type": "string", "x-aura-field-code": "sourcePath" }, "sourcePathWildcard": { "type": "string", "x-aura-field-code": "sourcePathWildcard" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what 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-file-transfer-by-id", "x-aura-domain": "integration", "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." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is 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": "update-file-transfer", "tags": [ "file-transfers" ], "summary": "update-file-transfer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "fileTransferId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "archiveFileStorageId": { "type": "string", "format": "uuid", "x-aura-field-code": "archiveFileStorageId" }, "archivePath": { "type": "string", "x-aura-field-code": "archivePath" }, "canArchive": { "type": "boolean", "x-aura-field-code": "canArchive" }, "code": { "type": "string", "x-aura-field-code": "code" }, "destinationFileStorageId": { "type": "string", "format": "uuid", "x-aura-field-code": "destinationFileStorageId" }, "destinationPath": { "type": "string", "x-aura-field-code": "destinationPath" }, "isZip": { "type": "boolean", "x-aura-field-code": "isZip" }, "name": { "type": "string", "x-aura-field-code": "name", "x-aura-maskable": true }, "overwriteType": { "type": "integer", "format": "int32", "x-aura-field-code": "overwriteType" }, "sourceFileStorageId": { "type": "string", "format": "uuid", "x-aura-field-code": "sourceFileStorageId" }, "sourcePath": { "type": "string", "x-aura-field-code": "sourcePath" }, "sourcePathWildcard": { "type": "string", "x-aura-field-code": "sourcePathWildcard" } }, "required": [ "canArchive", "code", "destinationFileStorageId", "destinationPath", "isZip", "name", "overwriteType", "sourceFileStorageId", "sourcePath", "sourcePathWildcard" ] } } } }, "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": 12, "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": "update-file-transfer", "x-aura-domain": "integration", "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" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is 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": "get-file-transfer-history-list", "tags": [ "file-transfers" ], "summary": "get-file-transfer-history-list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "fileTransferId" } }, { "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": { "beginDate": { "type": "string", "format": "date-time", "x-aura-field-code": "beginDate" }, "completedDate": { "type": "string", "format": "date-time", "x-aura-field-code": "completedDate" }, "errorDescription": { "type": "string", "x-aura-field-code": "errorDescription" }, "fileName": { "type": "string", "x-aura-field-code": "fileName" }, "fileSize": { "type": "integer", "format": "int32", "x-aura-field-code": "fileSize" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "fileTransferHistoryId" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "status" } } }, "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-file-transfer-history-list", "x-aura-domain": "integration", "x-aura-raw-url-path": "file-transfers/{id}/histories", "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": "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." } } }, "/financier/get-available-limit": { "get": { "operationId": "get-available-limit", "tags": [ "financier" ], "summary": "get-available-limit", "parameters": [ { "name": "birthDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "x-aura-field-code": "birthDate" } }, { "name": "citizenId", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "citizenId" } }, { "name": "educationLevel", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "educationLevel" } }, { "name": "employmentStatus", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "employmentStatus" } }, { "name": "isPermissionGranted", "in": "query", "required": false, "schema": { "type": "boolean", "x-aura-field-code": "isPermissionGranted" } }, { "name": "monthlyIncome", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "monthlyIncome" } }, { "name": "occupation", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "occupation" } }, { "name": "phoneNumber", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true } }, { "name": "productId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "productId" } }, { "name": "totalPrice", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "totalPrice" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "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. 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": { "dataSourceType": { "type": "integer", "format": "int32", "x-aura-field-code": "dataSourceType" }, "externalServiceResult": { "type": "object", "properties": { "applicationId": { "x-aura-type": "unresolved" }, "availableLimit": { "type": "number", "format": "decimal", "x-aura-field-code": "availableLimit" } }, "x-aura-field-code": "externalServiceResult" }, "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": "get-available-limit", "x-aura-domain": "integration", "x-aura-raw-url-path": "financier/get-available-limit", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CitizenId", "declared_type": null, "nullable": false, "collection": false }, { "name": "PhoneNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsPermissionGranted", "declared_type": null, "nullable": false, "collection": false }, { "name": "MonthlyIncome", "declared_type": null, "nullable": true, "collection": false }, { "name": "BirthDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "EmploymentStatus", "declared_type": null, "nullable": false, "collection": false }, { "name": "EducationLevel", "declared_type": null, "nullable": false, "collection": false }, { "name": "Occupation", "declared_type": null, "nullable": false, "collection": false }, { "name": "ProductId", "declared_type": null, "nullable": false, "collection": false }, { "name": "TotalPrice", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ExternalServiceResultDto", "envelopes": [ "ExternalServiceResultDto" ], "payload": "AvailableLimitDto", "collection": false, "members": [ { "name": "ApplicationId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AvailableLimit", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "MinInterestRate", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "MaxInterestRate", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "MaxTerm", "declared_type": "int", "nullable": false, "collection": false }, { "name": "MinAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "IsSuccess", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "InstallmentAmountForMaxTerm", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "ResponseCode", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ResponseMessage", "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_EXTLIMIT_1", "status": 400, "message": { "en": "An error was received in the External Limit query. Check the information or try again later. Service Response : {0}", "tr": "External Limit sorgusunda hata alındı. Bilgileri kontrol ediniz veya daha sonra tekrar deneyiniz. Service Cevabı : {0}" }, "message_available": true, "constant_name": "EXTERNAL_LIMIT_GENERAL_ERROR" } ] } } }, "/fraud-transactions/check": { "post": { "operationId": "check-fraud-transaction", "tags": [ "fraud-transactions" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "Check Fraud Transaction", "description": "Invokes the `check-fraud-transaction` service definition through `POST /fraud-transactions/check`.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "partnerCode": { "type": "string", "x-aura-field-code": "partnerCode" }, "products": { "type": "array", "items": { "type": "object", "x-aura-field-code": "products" } }, "transactionId": { "type": "string", "format": "uuid", "x-aura-field-code": "transactionId" } }, "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": 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": "check-fraud-transaction", "x-aura-domain": "integration", "x-aura-raw-url-path": "fraud-transactions/check", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PartnerCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "CheckFraudTransactionDto", "payload": "CheckFraudTransactionDto", "collection": false, "members": [ { "name": "IsFraud", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "FraudMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "HasSystemError", "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 } } }, "/generate-otp": { "post": { "operationId": "generate-activation-otp", "tags": [ "generate-otp" ], "summary": "generate-activation-otp", "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" } }, "required": [ "applicationName", "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": 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": "generate-activation-otp", "x-aura-domain": "integration", "x-aura-raw-url-path": "generate-otp", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "ApplicationName", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ActivationOtpDto", "payload": "ActivationOtpDto", "collection": false, "members": [ { "name": "Otp", "declared_type": "string", "nullable": false, "collection": false }, { "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 } } }, "/iban-queries": { "post": { "operationId": "iban-query", "tags": [ "iban-queries" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "iban-query", "description": "Invokes the `iban-query` service definition through `POST /iban-queries`.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "forceOnline": { "type": "boolean", "x-aura-field-code": "forceOnline" }, "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": 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": "iban-query", "x-aura-domain": "integration", "x-aura-raw-url-path": "iban-queries", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Iban", "declared_type": null, "nullable": false, "collection": false }, { "name": "ForceOnline", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ExternalServiceResultDto", "envelopes": [ "ExternalServiceResultDto" ], "payload": "CreateIbanQueryDto", "collection": false, "members": [ { "name": "TransactionResult", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransactionResultDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReturnCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReturnCodeDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReferenceNumber", "declared_type": "long", "nullable": false, "collection": false }, { "name": "DispositionAuthority", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AccountStatus", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CurrencyCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AccountOpeningDate", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PersonelInfos", "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_INTGRTN_81", "status": 400, "message": { "ar": "استعلام غير صالح: {0} - {1}" }, "message_available": true, "constant_name": "IBAN_COULD_NOT_BE_QUERIED" } ] } } }, "/iban-queries/tokens": { "post": { "operationId": "create-iban-query-token", "tags": [ "iban-queries" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "create-iban-query-token", "description": "Invokes the `create-iban-query-token` service definition through `POST /iban-queries/tokens`.", "x-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": { "accessToken": { "type": "string", "x-aura-field-code": "accessToken" }, "expireIn": { "x-aura-type": "unresolved" }, "refreshToken": { "type": "string", "x-aura-field-code": "refreshToken" }, "scope": { "type": "string", "x-aura-field-code": "scope" }, "tokenType": { "type": "string", "x-aura-field-code": "tokenType" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "accessToken": { "type": "string", "x-aura-field-code": "accessToken" }, "expireIn": { "x-aura-type": "unresolved" }, "refreshToken": { "type": "string", "x-aura-field-code": "refreshToken" }, "scope": { "type": "string", "x-aura-field-code": "scope" }, "tokenType": { "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": { "accessToken": { "type": "string", "x-aura-field-code": "accessToken" }, "expireIn": { "x-aura-type": "unresolved" }, "refreshToken": { "type": "string", "x-aura-field-code": "refreshToken" }, "scope": { "type": "string", "x-aura-field-code": "scope" }, "tokenType": { "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": "create-iban-query-token", "x-aura-domain": "integration", "x-aura-raw-url-path": "iban-queries/tokens", "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/ibans/check-ibans": { "post": { "operationId": "check-virtual-iban", "tags": [ "ibans" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "Check Virtual Iban", "description": "Invokes the `check-virtual-iban` service definition through `POST /ibans/check-ibans`.\n\nTurkish display name: Sanal Iban Kontrol", "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": "check-virtual-iban", "x-aura-domain": "integration", "x-aura-raw-url-path": "ibans/check-ibans", "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": "CheckVirtualIbanDto", "collection": false, "members": [ { "name": "CloseDate", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Fec", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OpenDate", "declared_type": "string", "nullable": false, "collection": false }, { "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 } } }, "/ibans/incomig-transactions": { "post": { "operationId": "get-incoming-transaction-list", "tags": [ "ibans" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "GetIncomingTransactionList", "description": "Invokes the `get-incoming-transaction-list` service definition through `POST /ibans/incomig-transactions`.\n\nTurkish display name: Gelen İşlem Listesini Al", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "startDate": { "type": "string", "format": "date-time", "x-aura-field-code": "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": 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 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": { "dataSourceType": { "type": "integer", "format": "int32", "x-aura-field-code": "dataSourceType" }, "externalServiceLogId": { "type": "string", "format": "uuid", "x-aura-field-code": "externalServiceLogId" }, "externalServiceResult": { "type": "object", "properties": { "incomingTransactionList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "comment": { "type": "string", "x-aura-field-code": "comment" }, "creditCardNumber": { "type": "string", "x-aura-field-code": "creditCardNumber" }, "fECId": { "type": "string", "x-aura-field-code": "fECId" }, "gibTransferType": { "type": "integer", "format": "int32", "x-aura-field-code": "gibTransferType" }, "queryToken": { "type": "integer", "format": "int64", "x-aura-field-code": "queryToken" }, "receiverAccountNumber": { "type": "string", "x-aura-field-code": "receiverAccountNumber" }, "receiverAddress": { "type": "string", "x-aura-field-code": "receiverAddress" }, "receiverFatherName": { "type": "string", "x-aura-field-code": "receiverFatherName" }, "receiverNameSurname": { "type": "string", "x-aura-field-code": "receiverNameSurname" }, "receiverPhoneNumber": { "type": "string", "x-aura-field-code": "receiverPhoneNumber" }, "receiverTaxNumber": { "type": "string", "x-aura-field-code": "receiverTaxNumber" }, "senderAccountNumber": { "type": "string", "x-aura-field-code": "senderAccountNumber" }, "senderAddress": { "type": "string", "x-aura-field-code": "senderAddress" }, "senderBankCode": { "type": "integer", "format": "int32", "x-aura-field-code": "senderBankCode" }, "senderBirthDate": { "type": "string", "x-aura-field-code": "senderBirthDate" }, "senderBirthPlace": { "type": "string", "x-aura-field-code": "senderBirthPlace" }, "senderBranchCode": { "type": "integer", "format": "int32", "x-aura-field-code": "senderBranchCode" }, "senderCustomerId": { "type": "string", "x-aura-field-code": "senderCustomerId" }, "senderNameSurname": { "type": "string", "x-aura-field-code": "senderNameSurname" }, "senderPassportNumber": { "type": "string", "x-aura-field-code": "senderPassportNumber" }, "senderPhoneNumber": { "type": "string", "x-aura-field-code": "senderPhoneNumber" }, "senderTaxNumber": { "type": "string", "x-aura-field-code": "senderTaxNumber" }, "tranDateWithTime": { "type": "string", "format": "date-time", "x-aura-field-code": "tranDateWithTime" }, "transactionCode": { "type": "string", "x-aura-field-code": "transactionCode" }, "transactionGuidId": { "type": "integer", "format": "int32", "x-aura-field-code": "transactionGuidId" } }, "x-aura-field-code": "incomingTransactionList" } }, "queryDate": { "type": "string", "format": "date-time", "x-aura-field-code": "queryDate" }, "queryPackageId": { "type": "integer", "format": "int32", "x-aura-field-code": "queryPackageId" }, "success": { "type": "boolean", "x-aura-field-code": "success" } }, "x-aura-field-code": "externalServiceResult" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what 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-incoming-transaction-list", "x-aura-domain": "integration", "x-aura-raw-url-path": "ibans/incomig-transactions", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "StartDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "EndDate", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ExternalServiceLogDto", "envelopes": [ "ExternalServiceLogDto" ], "payload": "GetIncomingTransactionListDto", "collection": false, "members": [ { "name": "QueryDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "QueryPackageId", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Success", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "IncomingTransactionList", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." } } }, "/identities/person-addresses": { "get": { "operationId": "get-person-address", "tags": [ "identities" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "get-person-address", "description": "Invokes the `get-person-address` service definition through `GET /identities/person-addresses`.", "parameters": [ { "name": "birthDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "x-aura-field-code": "birthDate" } }, { "name": "citizenNumber", "in": "query", "required": true, "schema": { "type": "string", "x-aura-field-code": "citizenNumber" } }, { "name": "queryDayNumber", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "queryDayNumber" } }, { "name": "queryType", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "queryType" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "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. 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": "get-person-address", "x-aura-domain": "integration", "x-aura-raw-url-path": "identities/person-addresses", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CitizenNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "BirthDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "QueryType", "declared_type": null, "nullable": false, "collection": false }, { "name": "QueryDayNumber", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ExternalServiceResultDto", "envelopes": [ "ExternalServiceResultDto" ], "payload": "PersonAddressDto", "collection": false, "members": [ { "name": "Citizenid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BirthDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "AddressType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "AddressSource", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "AddressOpenText", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ForeignAddress", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CountryId", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Country", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RegionCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Region", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CityCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "City", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DistrictCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "District", "declared_type": "string", "nullable": false, "collection": false }, { "name": "NeihgbourhoodCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Neihgbourhood", "declared_type": "string", "nullable": false, "collection": false }, { "name": "StreetCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Street", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BuildingCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Building", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SectionCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Section", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AddressNumber", "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 } } }, "/identities/person-info-changes": { "get": { "operationId": "get-person-info-changed", "tags": [ "identities" ], "summary": "get-person-info-changed", "parameters": [ { "name": "changeType", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "changeType" } }, { "name": "citizenNumber", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "x-aura-field-code": "getPersonInfoChanged_citizenNumber" } } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "x-aura-field-code": "endDate" } }, { "name": "pageNumber", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64", "x-aura-field-code": "pageNumber" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time", "x-aura-field-code": "startDate" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "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": { "externalServiceResult": { "type": "object", "properties": { "changeType": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "externalServiceResult_code" }, "description": { "type": "string", "x-aura-field-code": "description" } }, "x-aura-field-code": "externalServiceResult_changeType" }, "citizenNumber": { "type": "integer", "format": "int64", "x-aura-field-code": "externalServiceResult_citizenNumber" } }, "x-aura-field-code": "externalServiceResult" }, "externalServiceResultId": { "type": "string", "format": "uuid", "x-aura-field-code": "externalServiceResultId" } } }, "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-person-info-changed", "x-aura-domain": "integration", "x-aura-raw-url-path": "identities/person-info-changes", "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/identities/person-infos": { "get": { "operationId": "get-person-info", "tags": [ "identities" ], "summary": "get-person-info", "parameters": [ { "name": "birthDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "x-aura-field-code": "birthDate" } }, { "name": "citizenNumber", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64", "x-aura-field-code": "personInfo_citizenNumber" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "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 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": "object", "properties": { "binder": { "type": "string", "x-aura-field-code": "binder" }, "binderCode": { "type": "integer", "format": "int32", "x-aura-field-code": "binderCode" }, "birthDate": { "type": "string", "format": "date", "x-aura-field-code": "externalServiceResult_personInfo_birthDate" }, "birthPlace": { "type": "string", "x-aura-field-code": "externalServiceResult_personInfo_birthPlace" }, "birthPlaceCode": { "type": "integer", "format": "int32", "x-aura-field-code": "personInfo_birthPlaceCode" }, "citizenNumber": { "type": "integer", "format": "int64", "x-aura-field-code": "externalServiceResult_personInfo_citizenNumber" }, "citizenNumberTypeCode": { "type": "integer", "format": "int32", "x-aura-field-code": "citizenNumberTypeCode" }, "country": { "type": "string", "x-aura-field-code": "externalServiceResult_personInfo_country" }, "countryCode": { "type": "integer", "format": "int32", "x-aura-field-code": "personInfo_countryCode" }, "deathDate": { "type": "string", "format": "date-time", "x-aura-field-code": "externalServiceResult_personInfo_deathDate" }, "familyRecordNo": { "x-aura-type": "unresolved" }, "fatherName": { "type": "string", "x-aura-field-code": "fatherName" }, "gender": { "type": "string", "x-aura-field-code": "externalServiceResult_personInfo_gender" }, "genderCode": { "type": "integer", "format": "int32", "x-aura-field-code": "externalServiceResult_genderCode" }, "identityCardNo": { "type": "integer", "format": "int32", "x-aura-field-code": "externalServiceResult_identityCardNo" }, "identityCardSerialNo": { "type": "string", "x-aura-field-code": "identityCardSerialNo" }, "issueDate": { "type": "string", "format": "date-time", "x-aura-field-code": "issueDate" }, "issueOffice": { "type": "string", "x-aura-field-code": "issueOffice" }, "issueReason": { "type": "string", "x-aura-field-code": "issueReason" }, "maritalStatus": { "type": "string", "x-aura-field-code": "externalServiceResult_personInfo_maritalStatus" }, "maritalStatusCode": { "type": "integer", "format": "int32", "x-aura-field-code": "externalServiceResult_maritalStatusCode" }, "middleName": { "type": "string", "x-aura-field-code": "middleName" }, "motherName": { "type": "string", "x-aura-field-code": "motherName" }, "name": { "type": "string", "x-aura-field-code": "externalServiceResult_name" }, "nationality": { "type": "string", "x-aura-field-code": "externalServiceResult_personInfo_nationality" }, "nationalityCode": { "type": "integer", "format": "int32", "x-aura-field-code": "externalServiceResult_nationalityCode" }, "personRecordNo": { "type": "integer", "format": "int32", "x-aura-field-code": "personRecordNo" }, "previousSurname": { "type": "string", "x-aura-field-code": "previousSurname" }, "recordNo": { "type": "integer", "format": "int64", "x-aura-field-code": "recordNo" }, "registerCity": { "x-aura-type": "unresolved" }, "registerCityCode": { "type": "integer", "format": "int32", "x-aura-field-code": "registerCityCode" }, "registerDistinct": { "type": "string", "x-aura-field-code": "registerDistinct" }, "registerDistinctCode": { "type": "integer", "format": "int32", "x-aura-field-code": "registerDistinctCode" }, "status": { "type": "string", "x-aura-field-code": "personInfo_status" }, "statusCode": { "type": "integer", "format": "int32", "x-aura-field-code": "externalServiceResult_statusCode" }, "surName": { "type": "string", "x-aura-field-code": "externalServiceResult_surName" }, "validityDate": { "type": "string", "format": "date-time", "x-aura-field-code": "validityDate" } }, "x-aura-field-code": "externalServiceResult" }, "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": "get-person-info", "x-aura-domain": "integration", "x-aura-raw-url-path": "identities/person-infos", "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/identities/person-registration-changes": { "get": { "operationId": "get-person-registration-changed", "tags": [ "identities" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "get-person-registration-changed", "description": "Invokes the `get-person-registration-changed` service definition through `GET /identities/person-registration-changes`.", "parameters": [ { "name": "changedType", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "changedType" } }, { "name": "citizenids", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int64", "x-aura-field-code": "citizenids" } } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "x-aura-field-code": "personInfoEndDate" } }, { "name": "pageNumber", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64", "x-aura-field-code": "pageNumber" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "x-aura-field-code": "personInfoStartDate" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "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": "get-person-registration-changed", "x-aura-domain": "integration", "x-aura-raw-url-path": "identities/person-registration-changes", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "StartDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "EndDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChangedType", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageNumber", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ExternalServiceResultDto", "envelopes": [ "ExternalServiceResultDto" ], "payload": "PersonRegistrationChangedDto", "collection": false, "members": [ { "name": "PersonRegistrationChangeds", "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 } } }, "/identities/person-registrations": { "get": { "operationId": "get-person-registration", "tags": [ "identities" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "get-person-registration", "description": "Invokes the `get-person-registration` service definition through `GET /identities/person-registrations`.", "parameters": [ { "name": "birthDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "x-aura-field-code": "birthDate" } }, { "name": "citizenNumber", "in": "query", "required": true, "schema": { "type": "string", "x-aura-field-code": "citizenNumber" } }, { "name": "queryDayNumber", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "queryDayNumber" } }, { "name": "queryType", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "queryType" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "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. 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": "get-person-registration", "x-aura-domain": "integration", "x-aura-raw-url-path": "identities/person-registrations", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CitizenNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "BirthDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "QueryType", "declared_type": null, "nullable": false, "collection": false }, { "name": "QueryDayNumber", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ExternalServiceResultDto", "envelopes": [ "ExternalServiceResultDto" ], "payload": "PersonRegistrationDto", "collection": false, "members": [ { "name": "RegistrationType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Surname", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MotherName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FatherName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Gender", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "MaritalStatus", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "PreviousSurname", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Citizenid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BirthDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "BirthPlace", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MotherCitizenid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FatherCitizenid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SpouseCitizenid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CountryId", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Status", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "PreviousCitizenid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DeathDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "Nationality", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IdentityCardType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsTemporary", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "RegistrationNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SerialNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IssueReason", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IssueDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "IssueOffice", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ValidityDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "ForeignPermissionStartDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "ForeignPermissionEndDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "ForeignPermissionNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ForeignPermissionCity", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Unit", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FamilyRecordNo", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PersonRecordNo", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Binder", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RegisterCity", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RegisterDistrict", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Correlationid", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "HasGuardian", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "GuardianshipType", "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_INTGRTN_64", "status": 400, "message": { "ar": "خطأ في طلب خدمة Kps {0}", "en": "Kps Service Request Error {0}", "tr": "Girmiş olduğun bilgiler kimlik bilgilerin ile uyuşmamaktadır. Bilgilerini kimliğinde yazılan şekilde düzenleyerek yeniden deneyebilirsin." }, "message_available": true, "constant_name": "KPS_SERVICE_REQUEST_ERROR" } ] } } }, "/instant-payment": { "get": { "operationId": "get-instant-payment-message", "tags": [ "instant-payment" ], "summary": "get-instant-payment-message", "parameters": [ { "name": "fromParticipationCode", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "fromParticipationCode" } }, { "name": "instantQueryNumber", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64", "x-aura-field-code": "instantQueryNumber" } }, { "name": "transactionDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "x-aura-field-code": "transactionDate" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "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": "get-instant-payment-message", "x-aura-domain": "integration", "x-aura-raw-url-path": "instant-payment", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "TransactionDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "InstantQueryNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "FromParticipationCode", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ExternalServiceResultDto", "envelopes": [ "ExternalServiceResultDto" ], "payload": "BaseInstantPaymentDto", "collection": false, "members": [ { "name": "SuccessStatus", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "SuccessStatusCode", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Explanation", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InstantQueryNumber", "declared_type": "long", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "int", "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 } }, "post": { "operationId": "create-instant-payment", "tags": [ "instant-payment" ], "summary": "create-instant-payment", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "authorized": { "type": "object", "properties": { "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" }, "customerNumber": { "type": "string", "x-aura-field-code": "customerNumber" }, "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": [ "address", "birthDate", "birthPlace", "countryDistrict", "customerNumber", "iban", "identityNumber", "owner" ], "x-aura-field-code": "authorized" }, "channelCode": { "type": "string", "x-aura-field-code": "channelCode" }, "description": { "type": "string", "x-aura-field-code": "description" }, "from": { "type": "object", "properties": { "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" }, "countryCity": { "type": "string", "x-aura-field-code": "countryCity" }, "customerNumber": { "type": "string", "x-aura-field-code": "customerNumber" }, "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": "from" }, "instantQueryNumber": { "type": "integer", "format": "int64", "x-aura-field-code": "instantQueryNumber" }, "integrationAdditionalInfo": { "type": "object", "properties": { "authorizedPaymentProvider": { "type": "string", "x-aura-field-code": "authorizedPaymentProvider" }, "barcode": { "type": "object", "properties": { "barcodeRef": { "type": "string", "x-aura-field-code": "barcodeRef" }, "processType": { "type": "string", "x-aura-field-code": "processType" } }, "required": [ "barcodeRef", "processType" ], "x-aura-field-code": "barcodeInfo" }, "easyAddressRef": { "type": "string", "x-aura-field-code": "easyAddressRef" }, "securityPayment": { "type": "object", "properties": { "processType": { "type": "string", "x-aura-field-code": "processType" }, "securityPaymentRef": { "type": "string", "x-aura-field-code": "securityPaymentRef" } }, "required": [ "processType", "securityPaymentRef" ], "x-aura-field-code": "securityPayment" } }, "x-aura-field-code": "instantPaymentIntegrationAdditionalInfo" }, "paymentPurpose": { "type": "string", "x-aura-field-code": "instantPaymentPurpose" }, "to": { "type": "object", "properties": { "address": { "type": "string", "x-aura-field-code": "address" }, "birthDate": { "type": "string", "format": "date", "x-aura-field-code": "birthDate" }, "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", "owner" ], "x-aura-field-code": "toAccount" }, "toParticipationCode": { "type": "string", "x-aura-field-code": "toParticipationCode" }, "transactionid": { "type": "string", "x-aura-field-code": "transactionid" } }, "required": [ "amount", "channelCode", "description", "from", "instantQueryNumber", "paymentPurpose", "to", "toParticipationCode", "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": 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. 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": "create-instant-payment", "x-aura-domain": "integration", "x-aura-raw-url-path": "instant-payment", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PaymentPurpose", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChannelCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntegrationAdditionalInfo", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ExternalServiceResultDto", "envelopes": [ "ExternalServiceResultDto" ], "payload": "BaseInstantPaymentDto", "collection": false, "members": [ { "name": "SuccessStatus", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "SuccessStatusCode", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Explanation", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InstantQueryNumber", "declared_type": "long", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "int", "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 } } }, "/instant-payment/refund": { "post": { "operationId": "create-instant-payment-refund", "tags": [ "instant-payment" ], "summary": "create-instant-payment-refund", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "authorized": { "type": "object", "properties": { "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" }, "customerNumber": { "type": "string", "x-aura-field-code": "customerNumber" }, "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": [ "address", "birthDate", "birthPlace", "countryDistrict", "customerNumber", "iban", "identityNumber", "owner" ], "x-aura-field-code": "authorized" }, "description": { "type": "string", "x-aura-field-code": "description" }, "from": { "type": "object", "properties": { "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" }, "countryCity": { "type": "string", "x-aura-field-code": "countryCity" }, "customerNumber": { "type": "string", "x-aura-field-code": "customerNumber" }, "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", "owner" ], "x-aura-field-code": "from" }, "instantQueryNumber": { "type": "integer", "format": "int64", "x-aura-field-code": "instantQueryNumber" }, "relatedMessageInfo": { "type": "object", "properties": { "fromParticipationCode": { "type": "string", "x-aura-field-code": "fromParticipationCode" }, "relatedDate": { "type": "string", "format": "date-time", "x-aura-field-code": "relatedDate" }, "relatedTransferQueryNumber": { "type": "integer", "format": "int64", "x-aura-field-code": "relatedTransferQueryNumber" } }, "required": [ "fromParticipationCode", "relatedDate", "relatedTransferQueryNumber" ], "x-aura-field-code": "relatedMessageInfo" }, "returnCode": { "type": "string", "x-aura-field-code": "returnCode" }, "to": { "type": "object", "properties": { "address": { "type": "string", "x-aura-field-code": "address" }, "birthDate": { "type": "string", "format": "date", "x-aura-field-code": "birthDate" }, "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", "owner" ], "x-aura-field-code": "toAccount" }, "toParticipationCode": { "type": "string", "x-aura-field-code": "toParticipationCode" }, "transactionid": { "type": "string", "x-aura-field-code": "transactionid" } }, "required": [ "amount", "description", "from", "instantQueryNumber", "relatedMessageInfo", "returnCode", "to", "toParticipationCode", "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": "create-instant-payment-refund", "x-aura-domain": "integration", "x-aura-raw-url-path": "instant-payment/refund", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "ReturnCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "RelatedMessageInfo", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ExternalServiceResultDto", "envelopes": [ "ExternalServiceResultDto" ], "payload": "BaseInstantPaymentDto", "collection": false, "members": [ { "name": "SuccessStatus", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "SuccessStatusCode", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Explanation", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InstantQueryNumber", "declared_type": "long", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "int", "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 } } }, "/key-formats/{id}/items": { "post": { "operationId": "integration-create-key-format-item", "tags": [ "key-formats" ], "summary": "integration-create-key-format-item", "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": { "itemList": { "type": "array", "items": { "type": "object", "properties": { "defaultValue": { "type": "string", "x-aura-field-code": "defaultValue" }, "hasPadding": { "type": "boolean", "x-aura-field-code": "hasPadding" }, "itemLength": { "type": "integer", "format": "int32", "x-aura-field-code": "itemLength" }, "itemSequence": { "type": "integer", "format": "int32", "x-aura-field-code": "itemSequence" }, "itemValue": { "type": "string", "x-aura-field-code": "itemValue" }, "paddingDirection": { "type": "integer", "format": "int32", "x-aura-field-code": "paddingDirection" }, "resetValue": { "type": "integer", "format": "int32", "x-aura-field-code": "resetValue" }, "seperator": { "type": "string", "x-aura-field-code": "seperator" }, "translations": { "type": "array", "items": { "type": "object", "properties": { "languageCode": { "type": "string", "x-aura-field-code": "languageCode" }, "name": { "type": "string", "x-aura-field-code": "name", "x-aura-maskable": true } }, "required": [ "languageCode", "name" ], "x-aura-field-code": "translations" } }, "type": { "type": "integer", "format": "int32", "x-aura-field-code": "itemType" } }, "required": [ "hasPadding", "itemLength", "itemSequence", "seperator", "translations", "type" ], "x-aura-field-code": "itemList" } } }, "required": [ "itemList" ] } } } }, "x-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": "integration-create-key-format-item", "x-aura-domain": "integration", "x-aura-raw-url-path": "key-formats/{id}/items", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "CreateKeyFormatItemListDto", "payload": "CreateKeyFormatItemListDto", "collection": false, "members": [ { "name": "ItemList", "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_KYGNR_16", "status": 400, "message": null, "message_available": false, "constant_name": "KEY_FORMAT_NOT_FOUND_BY_ID" } ] } } }, "/krs-risk-reports/by-citizen-id/{citizenId}": { "get": { "operationId": "get-krs-risk-report-by-citizen-id", "tags": [ "krs-risk-reports" ], "summary": "get-krs-risk-report-by-citizen-id", "parameters": [ { "name": "citizenId", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "citizenId" } }, { "name": "dayCount", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "dayCount" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "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": "get-krs-risk-report-by-citizen-id", "x-aura-domain": "integration", "x-aura-raw-url-path": "krs-risk-reports/by-citizen-id/{citizenId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CitizenId", "declared_type": null, "nullable": false, "collection": false }, { "name": "DayCount", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "KrsReportDto", "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 } } }, "/kyc-references": { "get": { "operationId": "get-kyc-reference-list", "tags": [ "kyc-references" ], "summary": "get-kyc-reference-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" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "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": { "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": "clientReferenceId" } } }, "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-kyc-reference-list", "x-aura-domain": "integration", "x-aura-raw-url-path": "kyc-references", "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": "KycReferenceDto", "collection": true, "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." } }, "post": { "operationId": "create-kyc-reference", "tags": [ "kyc-references" ], "summary": "create-kyc-reference", "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" }, "description": { "type": "string", "x-aura-field-code": "description" }, "isSuccess": { "type": "boolean", "x-aura-field-code": "isSuccess" }, "referenceId": { "type": "string", "x-aura-field-code": "clientReferenceId" } }, "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": 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. 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": "create-kyc-reference", "x-aura-domain": "integration", "x-aura-raw-url-path": "kyc-references", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CitizenId", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsSuccess", "declared_type": null, "nullable": true, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": true, "collection": false }, { "name": "ReferenceId", "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 } } }, "/kyc-references/{id}": { "delete": { "operationId": "delete-kyc-reference", "tags": [ "kyc-references" ], "summary": "delete-kyc-reference", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "kycReferenceId", "x-aura-encrypted": true } } ], "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": "delete-kyc-reference", "x-aura-domain": "integration", "x-aura-raw-url-path": "kyc-references/{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" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is 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" } ] } }, "get": { "operationId": "get-kyc-reference-by-id", "tags": [ "kyc-references" ], "summary": "get-kyc-reference-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "kycReferenceId", "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": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row'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": "get-kyc-reference-by-id", "x-aura-domain": "integration", "x-aura-raw-url-path": "kyc-references/{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": "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-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_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" } ] } }, "put": { "operationId": "update-kyc-reference", "tags": [ "kyc-references" ], "summary": "update-kyc-reference", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "kycReferenceId", "x-aura-encrypted": true } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "description": { "type": "string", "x-aura-field-code": "description" }, "isSuccess": { "type": "boolean", "x-aura-field-code": "isSuccess" }, "referenceid": { "type": "string", "x-aura-field-code": "referenceid" } } } } } }, "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": "update-kyc-reference", "x-aura-domain": "integration", "x-aura-raw-url-path": "kyc-references/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsSuccess", "declared_type": null, "nullable": true, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "Referenceid", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "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_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" } ] } } }, "/limit-assignments/financial-analysis": { "post": { "operationId": "limit-assignment-financial-analysis", "tags": [ "limit-assignments" ], "summary": "limit-assignment-financial-analysis", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "analysisYear": { "type": "integer", "format": "int32", "x-aura-field-code": "analysisYear" }, "documentIds": { "type": "array", "items": { "type": "string", "x-aura-field-code": "documentIds" } }, "naceCode": { "type": "string", "x-aura-field-code": "naceCode" }, "workflowId": { "type": "string", "x-aura-field-code": "workflowId" } }, "required": [ "analysisYear", "documentIds", "naceCode", "workflowId" ] } } } }, "x-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": "limit-assignment-financial-analysis", "x-aura-domain": "integration", "x-aura-raw-url-path": "limit-assignments/financial-analysis", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "WorkflowId", "declared_type": null, "nullable": false, "collection": false }, { "name": "NaceCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "AnalysisYear", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "CreateFinancialAnalysisResponseDto", "payload": "CreateFinancialAnalysisResponseDto", "collection": false, "members": [ { "name": "Status", "declared_type": "int", "nullable": false, "collection": false }, { "name": "TaskId", "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 } } }, "/localizations": { "get": { "operationId": "integration-get-localization-list", "tags": [ "localizations" ], "summary": "integration-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": "integration-get-localization-list", "x-aura-domain": "integration", "x-aura-raw-url-path": "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": "not-parsed-in-repo" }, "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." } }, "post": { "operationId": "integration-create-localization", "tags": [ "localizations" ], "summary": "integration-create-localization", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "localizationCode" }, "translations": { "type": "array", "items": { "type": "object", "properties": { "context": { "type": "string", "x-aura-field-code": "context" }, "languageCode": { "type": "string", "x-aura-field-code": "languageCode" } }, "required": [ "context", "languageCode" ], "x-aura-field-code": "translations" } }, "type": { "type": "string", "x-aura-field-code": "localizationType" } }, "required": [ "code", "translations", "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 catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "integration-create-localization", "x-aura-domain": "integration", "x-aura-raw-url-path": "localizations", "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." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LCLZ_1", "status": 400, "message": null, "message_available": false, "constant_name": null } ] } } }, "/localizations/by-code/{code}": { "get": { "operationId": "integration-get-localization-by-code", "tags": [ "localizations" ], "summary": "integration-get-localization-by-code", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "localizationCode" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "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": "integration-get-localization-by-code", "x-aura-domain": "integration", "x-aura-raw-url-path": "localizations/by-code/{code}", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "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." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LCLZ_3", "status": 400, "message": null, "message_available": false, "constant_name": null } ] } } }, "/localizations/{id}": { "delete": { "operationId": "integration-delete-localization", "tags": [ "localizations" ], "summary": "integration-delete-localization", "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": "integration-delete-localization", "x-aura-domain": "integration", "x-aura-raw-url-path": "localizations/{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.", "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_LCLZ_3", "status": 400, "message": null, "message_available": false, "constant_name": null } ] } }, "get": { "operationId": "integration-get-localization-by-id", "tags": [ "localizations" ], "summary": "integration-get-localization-by-id", "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. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "integration-get-localization-by-id", "x-aura-domain": "integration", "x-aura-raw-url-path": "localizations/{id}", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "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." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LCLZ_3", "status": 400, "message": null, "message_available": false, "constant_name": null } ] } }, "put": { "operationId": "integration-update-localization", "tags": [ "localizations" ], "summary": "integration-update-localization", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "localizationId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "translations": { "type": "array", "items": { "type": "object", "properties": { "context": { "type": "string", "x-aura-field-code": "context" }, "languageCode": { "type": "string", "x-aura-field-code": "languageCode" } }, "required": [ "context", "languageCode" ], "x-aura-field-code": "translations" } }, "type": { "type": "string", "x-aura-field-code": "localizationType" } }, "required": [ "translations", "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": 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": "integration-update-localization", "x-aura-domain": "integration", "x-aura-raw-url-path": "localizations/{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.", "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_LCLZ_3", "status": 400, "message": null, "message_available": false, "constant_name": null } ] } } }, "/localizations/{id}/translations": { "get": { "operationId": "integration-get-localization-translation-by-localization-id", "tags": [ "localizations" ], "summary": "integration-get-localization-translation-by-localization-id", "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. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "integration-get-localization-translation-by-localization-id", "x-aura-domain": "integration", "x-aura-raw-url-path": "localizations/{id}/translations", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "LocalizationTranslationDto", "collection": true, "members": [ { "name": "TranslationId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "LanguageCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Context", "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_LCLZ_3", "status": 400, "message": null, "message_available": false, "constant_name": null } ] } }, "post": { "operationId": "integration-create-localization-translation", "tags": [ "localizations" ], "summary": "integration-create-localization-translation", "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": { "translations": { "type": "array", "items": { "type": "object", "properties": { "context": { "type": "string", "x-aura-field-code": "context" }, "languageCode": { "type": "string", "x-aura-field-code": "languageCode" } }, "required": [ "context", "languageCode" ], "x-aura-field-code": "translations" } } }, "required": [ "translations" ] } } } }, "x-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": "integration-create-localization-translation", "x-aura-domain": "integration", "x-aura-raw-url-path": "localizations/{id}/translations", "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" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LCLZ_2", "status": 400, "message": null, "message_available": false, "constant_name": null }, { "code": "ERR_LCLZ_3", "status": 400, "message": null, "message_available": false, "constant_name": null } ] } } }, "/localizations/{id}/translations/{translationId}": { "delete": { "operationId": "integration-delete-localization-translation", "tags": [ "localizations" ], "summary": "integration-delete-localization-translation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "localizationId" } }, { "name": "translationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "translationId" } } ], "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": "integration-delete-localization-translation", "x-aura-domain": "integration", "x-aura-raw-url-path": "localizations/{id}/translations/{translationId}", "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.", "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_LCLZ_3", "status": 400, "message": null, "message_available": false, "constant_name": null }, { "code": "ERR_LCLZ_4", "status": 400, "message": null, "message_available": false, "constant_name": null } ] } }, "put": { "operationId": "integration-update-localization-translation", "tags": [ "localizations" ], "summary": "integration-update-localization-translation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "localizationId" } }, { "name": "translationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "translationId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "context": { "type": "string", "x-aura-field-code": "context" } }, "required": [ "context" ] } } } }, "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": 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": "integration-update-localization-translation", "x-aura-domain": "integration", "x-aura-raw-url-path": "localizations/{id}/translations/{translationId}", "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.", "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_LCLZ_3", "status": 400, "message": null, "message_available": false, "constant_name": null }, { "code": "ERR_LCLZ_4", "status": 400, "message": null, "message_available": false, "constant_name": null } ] } } }, "/notification-providers": { "get": { "operationId": "get-notification-provider-list", "tags": [ "notification-providers" ], "summary": "get-notification-provider-list", "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", "properties": { "comparer": { "type": "object", "x-aura-field-code": "comparer" }, "count": { "type": "integer", "format": "int32", "x-aura-field-code": "count" }, "item": { "type": "object", "x-aura-field-code": "item" }, "keys": { "type": "array", "items": { "type": "object", "x-aura-field-code": "keys" } }, "values": { "type": "array", "items": { "type": "object", "x-aura-field-code": "values" } } }, "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": "get-notification-provider-list", "x-aura-domain": "integration", "x-aura-raw-url-path": "notification-providers", "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": "NotificationProviderDto", "collection": true, "members": [ { "name": "Provider", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Type", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ExternalServiceDefinitionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "IsDefault", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "IsActive", "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": "create-notification-provider", "tags": [ "notification-providers" ], "summary": "create-notification-provider", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "externalServiceDefinitionId": { "type": "string", "format": "uuid", "x-aura-field-code": "externalServiceDefinitionId" }, "provider": { "type": "integer", "format": "int32", "x-aura-field-code": "provider" }, "type": { "type": "integer", "format": "int32", "x-aura-field-code": "notificationType" } }, "required": [ "externalServiceDefinitionId", "provider", "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. 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": "create-notification-provider", "x-aura-domain": "integration", "x-aura-raw-url-path": "notification-providers", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Provider", "declared_type": null, "nullable": true, "collection": false }, { "name": "Type", "declared_type": null, "nullable": true, "collection": false }, { "name": "ExternalServiceDefinitionId", "declared_type": null, "nullable": true, "collection": false }, { "name": "isDefault", "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_INTGRTN_42", "status": 400, "message": null, "message_available": false, "constant_name": "NOTIFICATION_PROVIDER_ALSO_FOUND" } ] } } }, "/notification-providers/mail-results": { "get": { "operationId": "get-notification-mail-result-list", "tags": [ "notification-providers" ], "summary": "get-notification-mail-result-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" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "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": { "correlationId": { "type": "string", "format": "uuid", "x-aura-field-code": "correlationId" }, "deliveryTime": { "type": "string", "format": "date-time", "x-aura-field-code": "deliveryTime" }, "errorCode": { "type": "string", "x-aura-field-code": "errorCode" }, "errorMessage": { "type": "string", "x-aura-field-code": "errorMessage" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "notificationMailResultId" }, "isSuccess": { "type": "boolean", "x-aura-field-code": "isSuccess" }, "mailNotificationDetailId": { "type": "string", "format": "uuid", "x-aura-field-code": "mailNotificationDetailId" }, "notificationProviderId": { "type": "string", "format": "uuid", "x-aura-field-code": "notificationProviderId" } } }, "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-notification-mail-result-list", "x-aura-domain": "integration", "x-aura-raw-url-path": "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-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": "NotificationMailResultDto", "collection": true, "members": [ { "name": "MailNotificationDetailId", "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." } } }, "/notification-providers/{id}": { "delete": { "operationId": "delete-notification-provider", "tags": [ "notification-providers" ], "summary": "delete-notification-provider", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "notificationId" } } ], "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": "delete-notification-provider", "x-aura-domain": "integration", "x-aura-raw-url-path": "notification-providers/{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" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is 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_43", "status": 400, "message": null, "message_available": false, "constant_name": "NOTIFICATIONS_PROVIDER_NOT_FOUND" } ] } }, "get": { "operationId": "get-notification-provider-by-id", "tags": [ "notification-providers" ], "summary": "get-notification-provider-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "notificationId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "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": { "externalServiceDefinitionId": { "type": "string", "format": "uuid", "x-aura-field-code": "externalServiceDefinitionId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "notificationId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "provider": { "type": "integer", "format": "int32", "x-aura-field-code": "provider" }, "type": { "type": "integer", "format": "int32", "x-aura-field-code": "notificationType" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what 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-notification-provider-by-id", "x-aura-domain": "integration", "x-aura-raw-url-path": "notification-providers/{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": "NotificationProviderDto", "payload": "NotificationProviderDto", "collection": false, "members": [ { "name": "Provider", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Type", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ExternalServiceDefinitionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "IsDefault", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "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_43", "status": 400, "message": null, "message_available": false, "constant_name": "NOTIFICATIONS_PROVIDER_NOT_FOUND" } ] } }, "put": { "operationId": "update-notification-provider", "tags": [ "notification-providers" ], "summary": "update-notification-provider", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "notificationId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "externalServiceDefinitionId": { "type": "string", "format": "uuid", "x-aura-field-code": "externalServiceDefinitionId" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "provider": { "type": "integer", "format": "int32", "x-aura-field-code": "provider" }, "type": { "type": "integer", "format": "int32", "x-aura-field-code": "notificationType" } }, "required": [ "externalServiceDefinitionId", "isActive", "provider", "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. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "update-notification-provider", "x-aura-domain": "integration", "x-aura-raw-url-path": "notification-providers/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Provider", "declared_type": null, "nullable": true, "collection": false }, { "name": "Type", "declared_type": null, "nullable": true, "collection": false }, { "name": "ExternalServiceDefinitionId", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": null, "nullable": false, "collection": false }, { "name": "isDefault", "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_INTGRTN_42", "status": 400, "message": null, "message_available": false, "constant_name": "NOTIFICATION_PROVIDER_ALSO_FOUND" }, { "code": "ERR_INTGRTN_43", "status": 400, "message": null, "message_available": false, "constant_name": "NOTIFICATIONS_PROVIDER_NOT_FOUND" } ] } } }, "/notification-providers/{id}/mail-results": { "post": { "operationId": "create-notification-mail-result", "tags": [ "notification-providers" ], "summary": "create-notification-mail-result", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "correlationId": { "type": "string", "format": "uuid", "x-aura-field-code": "correlationId" } } } } } }, "x-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 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": "create-notification-mail-result", "x-aura-domain": "integration", "x-aura-raw-url-path": "notification-providers/{id}/mail-results", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "MailNotificationDetailId", "declared_type": null, "nullable": true, "collection": false }, { "name": "CorrelationId", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsSuccess", "declared_type": null, "nullable": true, "collection": false }, { "name": "DeliveryTime", "declared_type": null, "nullable": true, "collection": false }, { "name": "ErrorCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ErrorMessage", "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_43", "status": 400, "message": null, "message_available": false, "constant_name": "NOTIFICATIONS_PROVIDER_NOT_FOUND" } ] } } }, "/notification-providers/{id}/mail-results/{notificationMailResultId}": { "delete": { "operationId": "delete-notification-mail-result", "tags": [ "notification-providers" ], "summary": "delete-notification-mail-result", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "notificationId" } }, { "name": "notificationMailResultId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "notificationMailResultId" } } ], "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": "delete-notification-mail-result", "x-aura-domain": "integration", "x-aura-raw-url-path": "notification-providers/{id}/mail-results/{notificationMailResultId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "NotificationMailResultId", "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_43", "status": 400, "message": null, "message_available": false, "constant_name": "NOTIFICATIONS_PROVIDER_NOT_FOUND" } ] } }, "get": { "operationId": "get-notification-mail-result-by-id", "tags": [ "notification-providers" ], "summary": "get-notification-mail-result-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "notificationProviderId" } }, { "name": "notificationMailResultId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "notificationMailResultId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "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": { "correlationId": { "type": "string", "format": "uuid", "x-aura-field-code": "correlationId" }, "deliveryTime": { "type": "string", "format": "date-time", "x-aura-field-code": "deliveryTime" }, "errorCode": { "type": "string", "x-aura-field-code": "errorCode" }, "errorMessage": { "type": "string", "x-aura-field-code": "errorMessage" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "notificationMailResultId" }, "isSuccess": { "type": "boolean", "x-aura-field-code": "isSuccess" }, "mailNotificationDetailId": { "type": "string", "format": "uuid", "x-aura-field-code": "mailNotificationDetailId" }, "notificationProviderId": { "type": "string", "format": "uuid", "x-aura-field-code": "notificationProviderId" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what 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-notification-mail-result-by-id", "x-aura-domain": "integration", "x-aura-raw-url-path": "notification-providers/{id}/mail-results/{notificationMailResultId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "NotificationMailResultId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "NotificationMailResultDto", "payload": "NotificationMailResultDto", "collection": false, "members": [ { "name": "MailNotificationDetailId", "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." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is 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_43", "status": 400, "message": null, "message_available": false, "constant_name": "NOTIFICATIONS_PROVIDER_NOT_FOUND" } ] } }, "put": { "operationId": "update-notification-mail-result", "tags": [ "notification-providers" ], "summary": "update-notification-mail-result", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "notificationId" } }, { "name": "notificationMailResultId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "notificationMailResultId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "correlationId": { "type": "string", "format": "uuid", "x-aura-field-code": "correlationId" }, "deliveryTime": { "type": "string", "format": "date-time", "x-aura-field-code": "deliveryTime" }, "errorCode": { "type": "string", "x-aura-field-code": "errorCode" }, "errorMessage": { "type": "string", "x-aura-field-code": "errorMessage" }, "isSuccess": { "type": "boolean", "x-aura-field-code": "isSuccess" }, "mailNotificationDetailId": { "type": "string", "format": "uuid", "x-aura-field-code": "mailNotificationDetailId" } }, "required": [ "deliveryTime", "errorCode", "errorMessage", "isSuccess", "mailNotificationDetailId" ] } } } }, "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. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "update-notification-mail-result", "x-aura-domain": "integration", "x-aura-raw-url-path": "notification-providers/{id}/mail-results/{notificationMailResultId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "NotificationMailResultId", "declared_type": null, "nullable": false, "collection": false }, { "name": "MailNotificationDetailId", "declared_type": null, "nullable": true, "collection": false }, { "name": "CorrelationId", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsSuccess", "declared_type": null, "nullable": true, "collection": false }, { "name": "DeliveryTime", "declared_type": null, "nullable": true, "collection": false }, { "name": "ErrorCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ErrorMessage", "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_43", "status": 400, "message": null, "message_available": false, "constant_name": "NOTIFICATIONS_PROVIDER_NOT_FOUND" } ] } } }, "/notification-providers/{id}/sms-results": { "post": { "operationId": "create-notification-sms-result", "tags": [ "notification-providers" ], "summary": "create-notification-sms-result", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "notificationProviderId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "correlationId": { "type": "string", "format": "uuid", "x-aura-field-code": "correlationId" }, "deliveryTime": { "type": "string", "format": "date-time", "x-aura-field-code": "deliveryTime" }, "errorCode": { "type": "string", "x-aura-field-code": "errorCode" }, "errorMessage": { "type": "string", "x-aura-field-code": "errorMessage" }, "isSuccess": { "type": "boolean", "x-aura-field-code": "isSuccess" }, "smsNotificationDetailId": { "type": "string", "format": "uuid", "x-aura-field-code": "smsNotificationDetailId" } }, "required": [ "deliveryTime", "errorCode", "errorMessage", "isSuccess", "smsNotificationDetailId" ] } } } }, "x-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": 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 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": "create-notification-sms-result", "x-aura-domain": "integration", "x-aura-raw-url-path": "notification-providers/{id}/sms-results", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "SmsNotificationDetailId", "declared_type": null, "nullable": true, "collection": false }, { "name": "CorrelationId", "declared_type": null, "nullable": true, "collection": false }, { "name": "DeliveryTime", "declared_type": null, "nullable": false, "collection": false }, { "name": "ErrorCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ErrorMessage", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsSuccess", "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_43", "status": 400, "message": null, "message_available": false, "constant_name": "NOTIFICATIONS_PROVIDER_NOT_FOUND" } ] } } }, "/notification-providers/{id}/sms-results/{notificationSmsResultId}": { "delete": { "operationId": "delete-notification-sms-result", "tags": [ "notification-providers" ], "summary": "delete-notification-sms-result", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "notificationProviderId" } }, { "name": "notificationSmsResultId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "notificationSmsResultId" } } ], "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": "delete-notification-sms-result", "x-aura-domain": "integration", "x-aura-raw-url-path": "notification-providers/{id}/sms-results/{notificationSmsResultId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "NotificationSmsResultId", "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_43", "status": 400, "message": null, "message_available": false, "constant_name": "NOTIFICATIONS_PROVIDER_NOT_FOUND" }, { "code": "ERR_INTGRTN_44", "status": 400, "message": null, "message_available": false, "constant_name": "SMS_NOTIFICATION_RESULT_NOT_FOUND" } ] } }, "get": { "operationId": "get-notification-sms-result-by-id", "tags": [ "notification-providers" ], "summary": "get-notification-sms-result-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "notificationProviderId" } }, { "name": "notificationSmsResultId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "notificationSmsResultId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "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": { "correlationId": { "type": "string", "format": "uuid", "x-aura-field-code": "correlationId" }, "deliveryTime": { "type": "string", "format": "date-time", "x-aura-field-code": "deliveryTime" }, "errorCode": { "type": "string", "x-aura-field-code": "errorCode" }, "errorMessage": { "type": "string", "x-aura-field-code": "errorMessage" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "notificationSmsResultId" }, "isSuccess": { "type": "boolean", "x-aura-field-code": "isSuccess" }, "notificationProviderId": { "type": "string", "format": "uuid", "x-aura-field-code": "notificationProviderId" }, "smsNotificationDetailId": { "type": "string", "format": "uuid", "x-aura-field-code": "smsNotificationDetailId" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what 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-notification-sms-result-by-id", "x-aura-domain": "integration", "x-aura-raw-url-path": "notification-providers/{id}/sms-results/{notificationSmsResultId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "NotificationSmsResultId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "NotificationSmsResultDto", "payload": "NotificationSmsResultDto", "collection": false, "members": [ { "name": "NotificationProviderId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "SmsNotificationDetailId", "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." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is 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_43", "status": 400, "message": null, "message_available": false, "constant_name": "NOTIFICATIONS_PROVIDER_NOT_FOUND" }, { "code": "ERR_INTGRTN_44", "status": 400, "message": null, "message_available": false, "constant_name": "SMS_NOTIFICATION_RESULT_NOT_FOUND" } ] } }, "put": { "operationId": "update-notification-sms-result", "tags": [ "notification-providers" ], "summary": "update-notification-sms-result", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "notificationProviderId" } }, { "name": "notificationSmsResultId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "notificationSmsResultId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "correlationId": { "type": "string", "format": "uuid", "x-aura-field-code": "correlationId" }, "deliveryTime": { "type": "string", "format": "date-time", "x-aura-field-code": "deliveryTime" }, "errorCode": { "type": "string", "x-aura-field-code": "errorCode" }, "errorMessage": { "type": "string", "x-aura-field-code": "errorMessage" }, "isSuccess": { "type": "boolean", "x-aura-field-code": "isSuccess" }, "smsNotificationDetailId": { "type": "string", "format": "uuid", "x-aura-field-code": "smsNotificationDetailId" } }, "required": [ "deliveryTime", "errorCode", "errorMessage", "isSuccess", "smsNotificationDetailId" ] } } } }, "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. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "update-notification-sms-result", "x-aura-domain": "integration", "x-aura-raw-url-path": "notification-providers/{id}/sms-results/{notificationSmsResultId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "NotificationSmsResultId", "declared_type": null, "nullable": false, "collection": false }, { "name": "SmsNotificationDetailId", "declared_type": null, "nullable": true, "collection": false }, { "name": "CorrelationId", "declared_type": null, "nullable": true, "collection": false }, { "name": "DeliveryTime", "declared_type": null, "nullable": false, "collection": false }, { "name": "ErrorCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ErrorMessage", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsSuccess", "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_43", "status": 400, "message": null, "message_available": false, "constant_name": "NOTIFICATIONS_PROVIDER_NOT_FOUND" }, { "code": "ERR_INTGRTN_44", "status": 400, "message": null, "message_available": false, "constant_name": "SMS_NOTIFICATION_RESULT_NOT_FOUND" } ] } } }, "/parameters": { "get": { "operationId": "integration-get-parameter-list", "tags": [ "parameters" ], "summary": "integration-get-parameter-list", "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", "properties": { "comparer": { "type": "object", "x-aura-field-code": "comparer" }, "count": { "type": "integer", "format": "int32", "x-aura-field-code": "count" }, "item": { "type": "object", "x-aura-field-code": "item" }, "keys": { "type": "array", "items": { "type": "object", "x-aura-field-code": "keys" } }, "values": { "type": "array", "items": { "type": "object", "x-aura-field-code": "values" } } }, "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": 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": "integration-get-parameter-list", "x-aura-domain": "integration", "x-aura-raw-url-path": "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": "not-parsed-in-repo" }, "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." }, "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": "integration-create-parameter", "tags": [ "parameters" ], "summary": "integration-create-parameter", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "parameterCode" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "translations": { "type": "array", "items": { "type": "object", "properties": { "languageCode": { "type": "string", "x-aura-field-code": "languageCode" }, "name": { "type": "string", "x-aura-field-code": "parameterName" } }, "required": [ "languageCode", "name" ], "x-aura-field-code": "translations" } } }, "required": [ "code", "isActive", "translations" ] } } } }, "x-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": "integration-create-parameter", "x-aura-domain": "integration", "x-aura-raw-url-path": "parameters", "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." }, "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_1", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_CODE_ALREADY_EXISTS" } ] } } }, "/parameters/by-code/{code}": { "get": { "operationId": "integration-get-parameter-by-code", "tags": [ "parameters" ], "summary": "integration-get-parameter-by-code", "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. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "integration-get-parameter-by-code", "x-aura-domain": "integration", "x-aura-raw-url-path": "parameters/by-code/{code}", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "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-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is 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" } ] } } }, "/parameters/by-code/{code}/default-value": { "get": { "operationId": "integration-get-parameter-default-value-by-parameter-code", "tags": [ "parameters" ], "summary": "integration-get-parameter-default-value-by-parameter-code", "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. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "integration-get-parameter-default-value-by-parameter-code", "x-aura-domain": "integration", "x-aura-raw-url-path": "parameters/by-code/{code}/default-value", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "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_PRMTR_12", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_CODE_NOT_FOUND" }, { "code": "ERR_PRMTR_14", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_DEFAULT_VALUE_BY_CODE_NOT_EXISTS" } ] } } }, "/parameters/by-code/{code}/values": { "get": { "operationId": "integration-get-parameter-value-list-by-parameter-code", "tags": [ "parameters" ], "summary": "integration-get-parameter-value-list-by-parameter-code", "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. 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": "id" }, "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": "integration-get-parameter-value-list-by-parameter-code", "x-aura-domain": "integration", "x-aura-raw-url-path": "parameters/by-code/{code}/values", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "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" } ] } } }, "/parameters/{id}": { "delete": { "operationId": "integration-delete-parameter", "tags": [ "parameters" ], "summary": "integration-delete-parameter", "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": "integration-delete-parameter", "x-aura-domain": "integration", "x-aura-raw-url-path": "parameters/{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.", "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_PRMTR_2", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_ID_NOT_FOUND" } ] } }, "get": { "operationId": "integration-get-parameter-by-id", "tags": [ "parameters" ], "summary": "integration-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. 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": "integration-get-parameter-by-id", "x-aura-domain": "integration", "x-aura-raw-url-path": "parameters/{id}", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "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_2", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_ID_NOT_FOUND" } ] } }, "put": { "operationId": "integration-update-parameter", "tags": [ "parameters" ], "summary": "integration-update-parameter", "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": { "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "translations": { "type": "array", "items": { "type": "object", "properties": { "languageCode": { "type": "string", "x-aura-field-code": "languageCode" }, "name": { "type": "string", "x-aura-field-code": "parameterName" } }, "required": [ "languageCode", "name" ], "x-aura-field-code": "translations" } } }, "required": [ "isActive", "translations" ] } } } }, "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": "integration-update-parameter", "x-aura-domain": "integration", "x-aura-raw-url-path": "parameters/{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.", "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_PRMTR_2", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_ID_NOT_FOUND" } ] } } }, "/parameters/{id}/": { "get": { "operationId": "integration-get-parameter-value-list", "tags": [ "parameters" ], "summary": "integration-get-parameter-value-list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "parameterId" } }, { "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. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "integration-get-parameter-value-list", "x-aura-domain": "integration", "x-aura-raw-url-path": "parameters/{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": "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-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is 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_2", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_ID_NOT_FOUND" } ] } } }, "/parameters/{id}/default-value": { "get": { "operationId": "integration-get-parameter-default-value", "tags": [ "parameters" ], "summary": "integration-get-parameter-default-value", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "parameterId" } }, { "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. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "integration-get-parameter-default-value", "x-aura-domain": "integration", "x-aura-raw-url-path": "parameters/{id}/default-value", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "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_PRMTR_13", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_DEFAULT_VALUE_BY_ID_NOT_EXISTS" }, { "code": "ERR_PRMTR_2", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_ID_NOT_FOUND" } ] } } }, "/parameters/{id}/field-/{fieldValueId}": { "delete": { "operationId": "integration-delete-parameter-field-value", "tags": [ "parameters" ], "summary": "integration-delete-parameter-field-value", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "parameterId" } }, { "name": "fieldValueId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "fieldValueId" } } ], "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.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "integration-delete-parameter-field-value", "x-aura-domain": "integration", "x-aura-raw-url-path": "parameters/{id}/field-/{fieldValueId}", "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "put": { "operationId": "integration-update-parameter-field-value", "tags": [ "parameters" ], "summary": "integration-update-parameter-field-value", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "parameterId" } }, { "name": "fieldValueId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "fieldValueId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fieldValue": { "type": "string", "x-aura-field-code": "fieldValue" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" } }, "required": [ "fieldValue", "isActive" ] } } } }, "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": 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": "integration-update-parameter-field-value", "x-aura-domain": "integration", "x-aura-raw-url-path": "parameters/{id}/field-/{fieldValueId}", "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/parameters/{id}/fields": { "get": { "operationId": "integration-get-parameter-field-list", "tags": [ "parameters" ], "summary": "integration-get-parameter-field-list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "parameterId" } }, { "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. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "integration-get-parameter-field-list", "x-aura-domain": "integration", "x-aura-raw-url-path": "parameters/{id}/fields", "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": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "ParameterFieldDto", "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": "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_2", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_ID_NOT_FOUND" } ] } }, "post": { "operationId": "integration-create-parameter-field", "tags": [ "parameters" ], "summary": "integration-create-parameter-field", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "parameterId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "parameterCode" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "translations": { "type": "array", "items": { "type": "object", "properties": { "languageCode": { "type": "string", "x-aura-field-code": "languageCode" }, "name": { "type": "string", "x-aura-field-code": "parameterName" } }, "required": [ "languageCode", "name" ], "x-aura-field-code": "translations" } } }, "required": [ "code", "isActive", "translations" ] } } } }, "x-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. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "integration-create-parameter-field", "x-aura-domain": "integration", "x-aura-raw-url-path": "parameters/{id}/fields", "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." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is 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_2", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_ID_NOT_FOUND" }, { "code": "ERR_PRMTR_3", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_FIELD_CODE_ALREADY_EXISTS" } ] } } }, "/parameters/{id}/fields/{fieldId}": { "delete": { "operationId": "integration-delete-parameter-field", "tags": [ "parameters" ], "summary": "integration-delete-parameter-field", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "parameterId" } }, { "name": "fieldId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "fieldId" } } ], "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": "integration-delete-parameter-field", "x-aura-domain": "integration", "x-aura-raw-url-path": "parameters/{id}/fields/{fieldId}", "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.", "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_PRMTR_2", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_ID_NOT_FOUND" }, { "code": "ERR_PRMTR_5", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_FIELD_NOT_EXISTS" } ] } }, "put": { "operationId": "integration-update-parameter-field", "tags": [ "parameters" ], "summary": "integration-update-parameter-field", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "parameterId" } }, { "name": "fieldId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "fieldId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "translations": { "type": "array", "items": { "type": "object", "properties": { "languageCode": { "type": "string", "x-aura-field-code": "languageCode" }, "name": { "type": "string", "x-aura-field-code": "parameterName" } }, "required": [ "languageCode", "name" ], "x-aura-field-code": "translations" } } }, "required": [ "isActive", "translations" ] } } } }, "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": 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": "integration-update-parameter-field", "x-aura-domain": "integration", "x-aura-raw-url-path": "parameters/{id}/fields/{fieldId}", "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.", "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_PRMTR_2", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_ID_NOT_FOUND" }, { "code": "ERR_PRMTR_5", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_FIELD_NOT_EXISTS" } ] } } }, "/parameters/{id}/values": { "post": { "operationId": "integration-create-parameter-value", "tags": [ "parameters" ], "summary": "integration-create-parameter-value", "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": { "context": { "type": "string", "x-aura-field-code": "context" }, "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" } }, "required": [ "context", "languageCode" ], "x-aura-field-code": "translations" } } }, "required": [ "context", "isActive", "paramKey", "sortOrder", "translations" ] } } } }, "x-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. 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": "integration-create-parameter-value", "x-aura-domain": "integration", "x-aura-raw-url-path": "parameters/{id}/values", "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." }, "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_2", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_ID_NOT_FOUND" }, { "code": "ERR_PRMTR_7", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_VALUE_WITH_KEY_ALREADY_EXISTS" } ] } } }, "/parameters/{id}/{valueId}": { "delete": { "operationId": "integration-delete-parameter-value", "tags": [ "parameters" ], "summary": "integration-delete-parameter-value", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } }, { "name": "valueId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "valueId" } } ], "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.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "integration-delete-parameter-value", "x-aura-domain": "integration", "x-aura-raw-url-path": "parameters/{id}//{valueId}", "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "put": { "operationId": "integration-update-parameter-value", "tags": [ "parameters" ], "summary": "integration-update-parameter-value", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } }, { "name": "valueId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "valueId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "context": { "type": "string", "x-aura-field-code": "context" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "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" } }, "required": [ "context", "languageCode" ], "x-aura-field-code": "translations" } } }, "required": [ "context", "isActive", "sortOrder", "translations" ] } } } }, "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": 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": "integration-update-parameter-value", "x-aura-domain": "integration", "x-aura-raw-url-path": "parameters/{id}//{valueId}", "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/parameters/{id}/{valueId}/field-": { "get": { "operationId": "integration-get-parameter-field-value-list", "tags": [ "parameters" ], "summary": "integration-get-parameter-field-value-list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "parameterId" } }, { "name": "valueId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "valueId" } }, { "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": 2, "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.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "integration-get-parameter-field-value-list", "x-aura-domain": "integration", "x-aura-raw-url-path": "parameters/{id}//{valueId}/field-", "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." } }, "post": { "operationId": "integration-create-parameter-field-value", "tags": [ "parameters" ], "summary": "integration-create-parameter-field-value", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "parameterId" } }, { "name": "valueId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "valueId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fieldValues": { "type": "array", "items": { "type": "object", "properties": { "fieldValue": { "type": "string", "x-aura-field-code": "fieldValue" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "parameterFieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "parameterFieldId" } }, "required": [ "fieldValue", "isActive", "parameterFieldId" ], "x-aura-field-code": "fieldValues" } } }, "required": [ "fieldValues" ] } } } }, "x-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 catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "integration-create-parameter-field-value", "x-aura-domain": "integration", "x-aura-raw-url-path": "parameters/{id}//{valueId}/field-", "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/payfour/loan-application": { "post": { "operationId": "integration-loan-application", "tags": [ "payfour" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "integration-loan-application", "description": "Invokes the `integration-loan-application` service definition through `POST /payfour/loan-application`.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "firstLimit": { "type": "number", "format": "decimal", "x-aura-field-code": "firstLimit" }, "kycRefenceId": { "type": "string", "format": "uuid", "x-aura-field-code": "kycRefenceId" }, "secondLimit": { "type": "number", "format": "decimal", "x-aura-field-code": "secondLimit" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "status" } }, "required": [ "customerId", "firstLimit", "kycRefenceId", "secondLimit", "status" ] } } } }, "x-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. 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": "integration-loan-application", "x-aura-domain": "integration", "x-aura-raw-url-path": "payfour/loan-application", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "KycRefenceId", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "FirstLimit", "declared_type": null, "nullable": false, "collection": false }, { "name": "SecondLimit", "declared_type": null, "nullable": false, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ExternalServiceResultDto", "envelopes": [ "ExternalServiceResultDto" ], "payload": "LoanApplicationDto", "collection": false, "members": [ { "name": "Success", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Data", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Errors", "declared_type": "Error", "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 } } }, "/payfour/potential-limit": { "post": { "operationId": "integration-potential-limit", "tags": [ "payfour" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "integration-potential-limit", "description": "Invokes the `integration-potential-limit` service definition through `POST /payfour/potential-limit`.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "expireDate": { "type": "string", "format": "date-time", "x-aura-field-code": "expireDate" }, "firstLimit": { "type": "number", "format": "decimal", "x-aura-field-code": "firstLimit" }, "secondLimit": { "type": "number", "format": "decimal", "x-aura-field-code": "secondLimit" } }, "required": [ "customerId", "expireDate", "firstLimit", "secondLimit" ] } } } }, "x-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": "integration-potential-limit", "x-aura-domain": "integration", "x-aura-raw-url-path": "payfour/potential-limit", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "FirstLimit", "declared_type": null, "nullable": false, "collection": false }, { "name": "SecondLimit", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExpireDate", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ExternalServiceResultDto", "envelopes": [ "ExternalServiceResultDto" ], "payload": "PotentialLimitDto", "collection": false, "members": [ { "name": "Success", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Data", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Errors", "declared_type": "Error", "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 } } }, "/person-address-infos": { "get": { "operationId": "get-person-address-info-list", "tags": [ "person-address-infos" ], "summary": "get-person-address-info-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" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "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": { "addressNumber": { "type": "string", "x-aura-field-code": "personAddressNumber", "x-aura-maskable": true }, "addressOpenText": { "type": "string", "x-aura-field-code": "addressOpenText", "x-aura-maskable": true }, "addressSource": { "type": "integer", "format": "int32", "x-aura-field-code": "addressSource", "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" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "personAddressInfoId" }, "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" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what 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-person-address-info-list", "x-aura-domain": "integration", "x-aura-raw-url-path": "person-address-infos", "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": "PersonAddressInfoDto", "collection": true, "members": [ { "name": "ExternalServiceResultId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CorrelationId", "declared_type": "Guid?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." } }, "post": { "operationId": "create-person-address-info", "tags": [ "person-address-infos" ], "summary": "create-person-address-info", "requestBody": { "required": false, "content": { "application/json": { "schema": { "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 }, "addressSource": { "type": "integer", "format": "int32", "x-aura-field-code": "addressSource", "x-aura-maskable": true, "x-aura-parameter-enumeration": { "state": "resolved", "parameter": "address_source", "values": [ { "value": 1, "name": "Residency Address" }, { "value": 2, "name": "Other Address" } ] } }, "addressType": { "type": "integer", "format": "int32", "x-aura-field-code": "addressType", "x-aura-parameter-enumeration": { "state": "resolved", "parameter": "address_type", "values": [ { "value": 1, "name": "CityAddress" }, { "value": 2, "name": "TownAddress" }, { "value": 3, "name": "VillageAddress" } ] } }, "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-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 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": { "addressNumber": { "type": "string", "x-aura-field-code": "personAddressNumber", "x-aura-maskable": true }, "addressOpenText": { "type": "string", "x-aura-field-code": "addressOpenText", "x-aura-maskable": true }, "addressSource": { "type": "integer", "format": "int32", "x-aura-field-code": "addressSource", "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" }, "createdDate": { "x-aura-type": "unresolved" }, "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" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "personAddressInfoId" }, "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" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "create-person-address-info", "x-aura-domain": "integration", "x-aura-raw-url-path": "person-address-infos", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "ExternalServiceResultId", "declared_type": null, "nullable": true, "collection": false }, { "name": "AddressType", "declared_type": null, "nullable": true, "collection": false }, { "name": "AddressSource", "declared_type": null, "nullable": true, "collection": false }, { "name": "CorrelationId", "declared_type": null, "nullable": true, "collection": false }, { "name": "Citizenid", "declared_type": null, "nullable": false, "collection": false }, { "name": "BirthDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "AddressOpenText", "declared_type": null, "nullable": false, "collection": false }, { "name": "ForeignAddress", "declared_type": null, "nullable": false, "collection": false }, { "name": "CountryId", "declared_type": null, "nullable": true, "collection": false }, { "name": "Country", "declared_type": null, "nullable": false, "collection": false }, { "name": "RegionCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "Region", "declared_type": null, "nullable": false, "collection": false }, { "name": "CityCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "City", "declared_type": null, "nullable": false, "collection": false }, { "name": "DistrictCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "District", "declared_type": null, "nullable": false, "collection": false }, { "name": "NeihgbourhoodCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "Neihgbourhood", "declared_type": null, "nullable": false, "collection": false }, { "name": "StreetCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "Street", "declared_type": null, "nullable": false, "collection": false }, { "name": "BuildingCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "Building", "declared_type": null, "nullable": false, "collection": false }, { "name": "SectionCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "Section", "declared_type": null, "nullable": false, "collection": false }, { "name": "AddressNumber", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "PersonAddressInfoDto", "payload": "PersonAddressInfoDto", "collection": false, "members": [ { "name": "ExternalServiceResultId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CorrelationId", "declared_type": "Guid?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/person-address-infos/by-citizenid/{citizenid}": { "delete": { "operationId": "delete-person-address-info-by-citizenid", "tags": [ "person-address-infos" ], "summary": "delete-person-address-info-by-citizenid", "parameters": [ { "name": "citizenid", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true } } ], "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": "delete-person-address-info-by-citizenid", "x-aura-domain": "integration", "x-aura-raw-url-path": "person-address-infos/by-citizenid/{citizenid}", "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": "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_49", "status": 400, "message": { "ar": "معلومات عنوان الشخص غير موجودة", "en": "Person address info not found", "tr": "Müşteri adres bilgisi bulunamadı." }, "message_available": true, "constant_name": "PERSON_ADDRESS_INFO_NOT_FOUND" } ] } }, "get": { "operationId": "get-person-address-info-by-citizenid", "tags": [ "person-address-infos" ], "summary": "get-person-address-info-by-citizenid", "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 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": "get-person-address-info-by-citizenid", "x-aura-domain": "integration", "x-aura-raw-url-path": "person-address-infos/by-citizenid/{citizenid}", "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": "PersonAddressInfoDto", "payload": "PersonAddressInfoDto", "collection": false, "members": [ { "name": "ExternalServiceResultId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CorrelationId", "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_INTGRTN_49", "status": 400, "message": { "ar": "معلومات عنوان الشخص غير موجودة", "en": "Person address info not found", "tr": "Müşteri adres bilgisi bulunamadı." }, "message_available": true, "constant_name": "PERSON_ADDRESS_INFO_NOT_FOUND" } ] } } }, "/person-address-infos/{id}": { "delete": { "operationId": "delete-person-address-info", "tags": [ "person-address-infos" ], "summary": "delete-person-address-info", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "personAddressInfoId" } } ], "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": "delete-person-address-info", "x-aura-domain": "integration", "x-aura-raw-url-path": "person-address-infos/{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" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is 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_49", "status": 400, "message": { "ar": "معلومات عنوان الشخص غير موجودة", "en": "Person address info not found", "tr": "Müşteri adres bilgisi bulunamadı." }, "message_available": true, "constant_name": "PERSON_ADDRESS_INFO_NOT_FOUND" } ] } } }, "/person-info-changes": { "get": { "operationId": "get-person-info-changed-list", "tags": [ "person-info-changes" ], "summary": "get-person-info-changed-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" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "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": "get-person-info-changed-list", "x-aura-domain": "integration", "x-aura-raw-url-path": "person-info-changes", "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": "PersonInfoChangedDto", "collection": true, "members": [ { "name": "ExternalServiceResultId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Citizenid", "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": "ChangeType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CorrelationId", "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": "create-person-info-changed", "tags": [ "person-info-changes" ], "summary": "create-person-info-changed", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "changeType": { "type": "string", "x-aura-field-code": "changedType" }, "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "correlationId": { "type": "string", "format": "uuid", "x-aura-field-code": "correlationId" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "personInfoEndDate" }, "externalServiceResultId": { "type": "string", "format": "uuid", "x-aura-field-code": "externalServiceResultId" }, "startDate": { "type": "string", "format": "date", "x-aura-field-code": "personInfoStartDate" } }, "required": [ "changeType", "citizenid", "endDate", "externalServiceResultId", "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. 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": "create-person-info-changed", "x-aura-domain": "integration", "x-aura-raw-url-path": "person-info-changes", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "ExternalServiceResultId", "declared_type": null, "nullable": false, "collection": false }, { "name": "Citizenid", "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": "ChangeType", "declared_type": null, "nullable": false, "collection": false }, { "name": "CorrelationId", "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 } } }, "/person-info-changes/by-citizenid/{citizenid}": { "get": { "operationId": "get-person-info-changed-by-citizenid", "tags": [ "person-info-changes" ], "summary": "get-person-info-changed-by-citizenid", "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 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": "get-person-info-changed-by-citizenid", "x-aura-domain": "integration", "x-aura-raw-url-path": "person-info-changes/by-citizenid/{citizenid}", "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": "PersonInfoChangedDto", "payload": "PersonInfoChangedDto", "collection": false, "members": [ { "name": "ExternalServiceResultId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Citizenid", "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": "ChangeType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CorrelationId", "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_INTGRTN_17", "status": 400, "message": { "ar": "لا يمكن العثور على رقم المواطن.", "en": "Citizen Number cannot be found.", "tr": "Vatandaşlık numarası bulunamadı." }, "message_available": true, "constant_name": "CITIZEN_NUMBER_NOT_FOUND" } ] } } }, "/person-infos": { "get": { "operationId": "get-person-info-list", "tags": [ "person-infos" ], "summary": "get-person-info-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" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "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": { "binder": { "type": "string", "x-aura-field-code": "binder" }, "birthDate": { "type": "string", "format": "date", "x-aura-field-code": "birthDate" }, "birthPlace": { "type": "string", "x-aura-field-code": "personInfoBirthPlace" }, "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "correlationId": { "type": "string", "format": "uuid", "x-aura-field-code": "correlationId" }, "countryId": { "type": "integer", "format": "int32", "x-aura-field-code": "countryId" }, "deathDate": { "type": "string", "format": "date", "x-aura-field-code": "deathDate" }, "externalServiceResultId": { "type": "string", "format": "uuid", "x-aura-field-code": "externalServiceResultId" }, "familyRecordNo": { "type": "string", "x-aura-field-code": "familyRecordNo" }, "fatherCitizenid": { "type": "string", "x-aura-field-code": "fatherCitizenid" }, "fatherName": { "type": "string", "x-aura-field-code": "fatherName" }, "foreignPermissionCity": { "type": "string", "x-aura-field-code": "foreignPermissionCity" }, "foreignPermissionEndDate": { "type": "string", "format": "date", "x-aura-field-code": "foreignPermissionEndDate" }, "foreignPermissionNumber": { "type": "string", "x-aura-field-code": "foreignPermissionNumber" }, "foreignPermissionStartDate": { "type": "string", "format": "date", "x-aura-field-code": "foreignPermissionStartDate" }, "gender": { "type": "integer", "format": "int32", "x-aura-field-code": "gender" }, "guardianshipType": { "type": "integer", "format": "int32", "x-aura-field-code": "guardianshipType" }, "hasGuardian": { "type": "boolean", "x-aura-field-code": "hasGuardian" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "personInfoId" }, "identityCardType": { "type": "integer", "format": "int32", "x-aura-field-code": "identityCardType" }, "isTemporary": { "type": "boolean", "x-aura-field-code": "isTemporary" }, "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" }, "motherCitizenid": { "type": "string", "x-aura-field-code": "motherCitizenid" }, "motherName": { "type": "string", "x-aura-field-code": "motherName" }, "name": { "type": "string", "x-aura-field-code": "personInfoName", "x-aura-maskable": true }, "nationality": { "type": "integer", "format": "int32", "x-aura-field-code": "nationality" }, "personRecordNo": { "type": "string", "x-aura-field-code": "identityPersonRecordNo" }, "previousCitizenid": { "type": "string", "x-aura-field-code": "previousCitizenid" }, "previousSurname": { "type": "string", "x-aura-field-code": "previousSurname" }, "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" }, "registrationType": { "type": "integer", "format": "int32", "x-aura-field-code": "registrationType" }, "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" }, "surname": { "type": "string", "x-aura-field-code": "surname", "x-aura-maskable": true }, "unit": { "type": "string", "x-aura-field-code": "identityUnit" }, "validityDate": { "type": "string", "format": "date", "x-aura-field-code": "identityValidityDate" } } }, "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-person-info-list", "x-aura-domain": "integration", "x-aura-raw-url-path": "person-infos", "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": "PersonInfoDto", "collection": true, "members": [ { "name": "IsTemporary", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "RegistrationType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ExternalServiceResultId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Gender", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Status", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "MaritalStatus", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IdentityCardType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IssueReason", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Citizenid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PreviousCitizenid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FatherCitizenid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SpouseCitizenid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MotherCitizenid", "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": "PreviousSurname", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BirthDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "BirthPlace", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MotherName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FatherName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FamilyRecordNo", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PersonRecordNo", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Binder", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RegisterCity", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RegisterDistrict", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RegistrationNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SerialNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IssueOffice", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IssueDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "ValidityDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "Nationality", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CountryId", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "DeathDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "Unit", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ForeignPermissionCity", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ForeignPermissionStartDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "ForeignPermissionEndDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "ForeignPermissionNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CreatedDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "CorrelationId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "HasGuardian", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "GuardianshipType", "declared_type": "int?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." } }, "post": { "operationId": "create-person-info", "tags": [ "person-infos" ], "summary": "create-person-info", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "binder": { "type": "string", "x-aura-field-code": "binder" }, "birthDate": { "type": "string", "format": "date", "x-aura-field-code": "birthDate" }, "birthPlace": { "type": "string", "x-aura-field-code": "personInfoBirthPlace" }, "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "correlationId": { "type": "string", "format": "uuid", "x-aura-field-code": "correlationId" }, "countryId": { "type": "integer", "format": "int32", "x-aura-field-code": "countryId" }, "deathDate": { "type": "string", "format": "date", "x-aura-field-code": "deathDate" }, "externalServiceResultId": { "type": "string", "format": "uuid", "x-aura-field-code": "externalServiceResultId" }, "familyRecordNo": { "type": "string", "x-aura-field-code": "familyRecordNo" }, "fatherCitizenid": { "type": "string", "x-aura-field-code": "fatherCitizenid" }, "fatherName": { "type": "string", "x-aura-field-code": "fatherName" }, "foreignPermissionCity": { "type": "string", "x-aura-field-code": "foreignPermissionCity" }, "foreignPermissionEndDate": { "type": "string", "format": "date", "x-aura-field-code": "foreignPermissionEndDate" }, "foreignPermissionNumber": { "type": "string", "x-aura-field-code": "foreignPermissionNumber" }, "foreignPermissionStartDate": { "type": "string", "format": "date", "x-aura-field-code": "foreignPermissionStartDate" }, "gender": { "type": "integer", "format": "int32", "x-aura-field-code": "gender" }, "guardianshipType": { "type": "integer", "format": "int32", "x-aura-field-code": "guardianshipType", "x-aura-parameter-enumeration": { "state": "resolved", "parameter": "guardianship_type", "values": [ { "value": 0, "name": "Unknown", "labels": { "en": "Unknown", "tr": "Bilinmeyen", "ar": "غير معروف" } }, { "value": 1, "name": "Will", "labels": { "en": "Will", "tr": "Vasiyet", "ar": "وصية" } }, { "value": 2, "name": "Revocation of Will", "labels": { "en": "Revocation of Will", "tr": "Vasiyet İptali", "ar": "إلغاء الوصية" } }, { "value": 3, "name": "Appointment of Guardian", "labels": { "en": "Appointment of Guardian", "tr": "Vasi Tayini", "ar": "تعيين الوصي" } }, { "value": 4, "name": "Lifetime Care Contract", "labels": { "en": "Lifetime Care Contract", "tr": "Ölünceye Kadar Bakım Sözleşmesi", "ar": "عقد الرعاية مدى الحياة" } }, { "value": 5, "name": "Disinheritance", "labels": { "en": "Disinheritance", "tr": "Mirasçılıktan Çıkarma", "ar": "الحرمان من الإرث" } }, { "value": 6, "name": "Cancellation of Lifetime Care Contract", "labels": { "en": "Cancellation of Lifetime Care Contract", "tr": "Ölünceye Kadar Bakım Sözleşmesi İptali", "ar": "إلغاء عقد الرعاية مدى الحياة" } }, { "value": 7, "name": "Revocation of Disinheritance", "labels": { "en": "Revocation of Disinheritance", "tr": "Mirasçılıktan Çıkarmanın İptali", "ar": "إلغاء الحرمان من الإرث" } }, { "value": 8, "name": "Revocation of Waiver of Inheritance", "labels": { "en": "Revocation of Waiver of Inheritance", "tr": "Mirastan Feragatin İptali", "ar": "إلغاء التنازل عن الإرث" } }, { "value": 9, "name": "Inheritance Contract", "labels": { "en": "Inheritance Contract", "tr": "Miras Sözleşmesi", "ar": "عقد الميراث" } }, { "value": 10, "name": "Cancellation of Inheritance Contract", "labels": { "en": "Cancellation of Inheritance Contract", "tr": "Miras Sözleşmesi İptali", "ar": "إلغاء عقد الميراث" } }, { "value": 11, "name": "Withdrawal from Will", "labels": { "en": "Withdrawal from Will", "tr": "Vasiyetten Dönme", "ar": "الرجوع عن الوصية" } } ] } }, "hasGuardian": { "type": "boolean", "x-aura-field-code": "hasGuardian" }, "identityCardType": { "type": "integer", "format": "int32", "x-aura-field-code": "identityCardType", "x-aura-parameter-enumeration": { "state": "resolved", "parameter": "identity_card_type", "values": [ { "value": 1, "name": "Birth Certificate" }, { "value": 2, "name": "Identity Card" }, { "value": 3, "name": "Blue Card" }, { "value": 4, "name": "Passport" } ] } }, "isTemporary": { "type": "boolean", "x-aura-field-code": "isTemporary" }, "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" }, "motherCitizenid": { "type": "string", "x-aura-field-code": "motherCitizenid" }, "motherName": { "type": "string", "x-aura-field-code": "motherName" }, "name": { "type": "string", "x-aura-field-code": "personInfoName", "x-aura-maskable": true }, "nationality": { "type": "integer", "format": "int32", "x-aura-field-code": "nationality" }, "personRecordNo": { "type": "string", "x-aura-field-code": "identityPersonRecordNo" }, "previousCitizenid": { "type": "string", "x-aura-field-code": "previousCitizenid" }, "previousSurname": { "type": "string", "x-aura-field-code": "previousSurname" }, "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" }, "registrationType": { "type": "integer", "format": "int32", "x-aura-field-code": "registrationType", "x-aura-parameter-enumeration": { "state": "resolved", "parameter": "registration_type", "values": [ { "value": 1, "name": "TEst" }, { "value": 0, "name": "test_zero" } ] } }, "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", "x-aura-parameter-enumeration": { "state": "resolved", "parameter": "status", "values": [ { "value": 1, "name": "Open" }, { "value": 2, "name": "Close", "labels": { "ar": "إغلاق" } }, { "value": 3, "name": "Death", "labels": { "ar": "الموت" } }, { "value": 4, "name": "Unseen", "labels": { "ar": "غير مرئي" } }, { "value": 5, "name": "Renouncing Citizenship", "labels": { "ar": "التخلي عن المواطنة" } }, { "value": 14, "name": "Stopped", "labels": { "ar": "توقف" } }, { "value": 15, "name": "Secret", "labels": { "ar": "سرّ" } } ] } }, "surname": { "type": "string", "x-aura-field-code": "surname", "x-aura-maskable": true }, "unit": { "type": "string", "x-aura-field-code": "identityUnit" }, "validityDate": { "type": "string", "format": "date", "x-aura-field-code": "identityValidityDate" } }, "required": [ "isTemporary" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 41, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type 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": { "binder": { "type": "string", "x-aura-field-code": "binder" }, "birthDate": { "type": "string", "format": "date", "x-aura-field-code": "birthDate" }, "birthPlace": { "type": "string", "x-aura-field-code": "personInfoBirthPlace" }, "citizenid": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true }, "correlationId": { "type": "string", "format": "uuid", "x-aura-field-code": "correlationId" }, "countryId": { "type": "integer", "format": "int32", "x-aura-field-code": "countryId" }, "createdDate": { "x-aura-type": "unresolved" }, "deathDate": { "type": "string", "format": "date", "x-aura-field-code": "deathDate" }, "externalServiceResultId": { "type": "string", "format": "uuid", "x-aura-field-code": "externalServiceResultId" }, "familyRecordNo": { "type": "string", "x-aura-field-code": "familyRecordNo" }, "fatherCitizenid": { "type": "string", "x-aura-field-code": "fatherCitizenid" }, "fatherName": { "type": "string", "x-aura-field-code": "fatherName" }, "foreignPermissionCity": { "type": "string", "x-aura-field-code": "foreignPermissionCity" }, "foreignPermissionEndDate": { "type": "string", "format": "date", "x-aura-field-code": "foreignPermissionEndDate" }, "foreignPermissionNumber": { "type": "string", "x-aura-field-code": "foreignPermissionNumber" }, "foreignPermissionStartDate": { "type": "string", "format": "date", "x-aura-field-code": "foreignPermissionStartDate" }, "gender": { "type": "integer", "format": "int32", "x-aura-field-code": "gender" }, "guardianshipType": { "type": "integer", "format": "int32", "x-aura-field-code": "guardianshipType" }, "hasGuardian": { "type": "boolean", "x-aura-field-code": "hasGuardian" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "personInfoId" }, "identityCardType": { "type": "integer", "format": "int32", "x-aura-field-code": "identityCardType" }, "isTemporary": { "type": "boolean", "x-aura-field-code": "isTemporary" }, "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" }, "motherCitizenid": { "type": "string", "x-aura-field-code": "motherCitizenid" }, "motherName": { "type": "string", "x-aura-field-code": "motherName" }, "name": { "type": "string", "x-aura-field-code": "personInfoName", "x-aura-maskable": true }, "nationality": { "type": "integer", "format": "int32", "x-aura-field-code": "nationality" }, "personRecordNo": { "type": "string", "x-aura-field-code": "identityPersonRecordNo" }, "previousCitizenid": { "type": "string", "x-aura-field-code": "previousCitizenid" }, "previousSurname": { "type": "string", "x-aura-field-code": "previousSurname" }, "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" }, "registrationType": { "type": "integer", "format": "int32", "x-aura-field-code": "registrationType" }, "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" }, "surname": { "type": "string", "x-aura-field-code": "surname", "x-aura-maskable": true }, "unit": { "type": "string", "x-aura-field-code": "identityUnit" }, "validityDate": { "type": "string", "format": "date", "x-aura-field-code": "identityValidityDate" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "create-person-info", "x-aura-domain": "integration", "x-aura-raw-url-path": "person-infos", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "IsTemporary", "declared_type": null, "nullable": false, "collection": false }, { "name": "RegistrationType", "declared_type": null, "nullable": true, "collection": false }, { "name": "ExternalServiceResultId", "declared_type": null, "nullable": false, "collection": false }, { "name": "Gender", "declared_type": null, "nullable": true, "collection": false }, { "name": "Status", "declared_type": null, "nullable": true, "collection": false }, { "name": "MaritalStatus", "declared_type": null, "nullable": true, "collection": false }, { "name": "IdentityCardType", "declared_type": null, "nullable": true, "collection": false }, { "name": "IssueReason", "declared_type": null, "nullable": false, "collection": false }, { "name": "Citizenid", "declared_type": null, "nullable": false, "collection": false }, { "name": "PreviousCitizenid", "declared_type": null, "nullable": false, "collection": false }, { "name": "FatherCitizenid", "declared_type": null, "nullable": false, "collection": false }, { "name": "SpouseCitizenid", "declared_type": null, "nullable": false, "collection": false }, { "name": "MotherCitizenid", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "Surname", "declared_type": null, "nullable": false, "collection": false }, { "name": "PreviousSurname", "declared_type": null, "nullable": false, "collection": false }, { "name": "BirthDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "BirthPlace", "declared_type": null, "nullable": false, "collection": false }, { "name": "MotherName", "declared_type": null, "nullable": false, "collection": false }, { "name": "FatherName", "declared_type": null, "nullable": false, "collection": false }, { "name": "FamilyRecordNo", "declared_type": null, "nullable": false, "collection": false }, { "name": "PersonRecordNo", "declared_type": null, "nullable": false, "collection": false }, { "name": "Binder", "declared_type": null, "nullable": false, "collection": false }, { "name": "RegisterCity", "declared_type": null, "nullable": false, "collection": false }, { "name": "RegisterDistrict", "declared_type": null, "nullable": false, "collection": false }, { "name": "RegistrationNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "SerialNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "IssueOffice", "declared_type": null, "nullable": false, "collection": false }, { "name": "IssueDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "ValidityDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "Nationality", "declared_type": null, "nullable": true, "collection": false }, { "name": "CountryId", "declared_type": null, "nullable": true, "collection": false }, { "name": "DeathDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "Unit", "declared_type": null, "nullable": false, "collection": false }, { "name": "ForeignPermissionCity", "declared_type": null, "nullable": false, "collection": false }, { "name": "ForeignPermissionStartDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "ForeignPermissionEndDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "ForeignPermissionNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "CorrelationId", "declared_type": null, "nullable": true, "collection": false }, { "name": "HasGuardian", "declared_type": null, "nullable": true, "collection": false }, { "name": "GuardianshipType", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "PersonInfoDto", "payload": "PersonInfoDto", "collection": false, "members": [ { "name": "IsTemporary", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "RegistrationType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ExternalServiceResultId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Gender", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Status", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "MaritalStatus", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IdentityCardType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IssueReason", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Citizenid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PreviousCitizenid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FatherCitizenid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SpouseCitizenid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MotherCitizenid", "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": "PreviousSurname", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BirthDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "BirthPlace", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MotherName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FatherName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FamilyRecordNo", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PersonRecordNo", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Binder", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RegisterCity", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RegisterDistrict", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RegistrationNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SerialNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IssueOffice", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IssueDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "ValidityDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "Nationality", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CountryId", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "DeathDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "Unit", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ForeignPermissionCity", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ForeignPermissionStartDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "ForeignPermissionEndDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "ForeignPermissionNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CreatedDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "CorrelationId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "HasGuardian", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "GuardianshipType", "declared_type": "int?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/person-infos/by-citizenid/{citizenid}": { "delete": { "operationId": "delete-person-info-by-citizenid", "tags": [ "person-infos" ], "summary": "delete-person-info-by-citizenid", "parameters": [ { "name": "citizenid", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "citizenid", "x-aura-maskable": true } } ], "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": "delete-person-info-by-citizenid", "x-aura-domain": "integration", "x-aura-raw-url-path": "person-infos/by-citizenid/{citizenid}", "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": "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_47", "status": 400, "message": { "ar": "لم يتم العثور على معلمة معلومات الشخص.", "en": "Person Info Parameter not found.", "tr": "Kişi bilgisi bulunamadı" }, "message_available": true, "constant_name": "PERSON_INFO_NOT_FOUND" } ] } }, "get": { "operationId": "get-person-info-by-citizenid", "tags": [ "person-infos" ], "summary": "get-person-info-by-citizenid", "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 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": "get-person-info-by-citizenid", "x-aura-domain": "integration", "x-aura-raw-url-path": "person-infos/by-citizenid/{citizenid}", "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": "PersonInfoDto", "payload": "PersonInfoDto", "collection": false, "members": [ { "name": "IsTemporary", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "RegistrationType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ExternalServiceResultId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Gender", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Status", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "MaritalStatus", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IdentityCardType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IssueReason", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Citizenid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PreviousCitizenid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FatherCitizenid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SpouseCitizenid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MotherCitizenid", "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": "PreviousSurname", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BirthDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "BirthPlace", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MotherName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FatherName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FamilyRecordNo", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PersonRecordNo", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Binder", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RegisterCity", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RegisterDistrict", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RegistrationNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SerialNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IssueOffice", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IssueDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "ValidityDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "Nationality", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CountryId", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "DeathDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "Unit", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ForeignPermissionCity", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ForeignPermissionStartDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "ForeignPermissionEndDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "ForeignPermissionNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CreatedDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "CorrelationId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "HasGuardian", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "GuardianshipType", "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_INTGRTN_17", "status": 400, "message": { "ar": "لا يمكن العثور على رقم المواطن.", "en": "Citizen Number cannot be found.", "tr": "Vatandaşlık numarası bulunamadı." }, "message_available": true, "constant_name": "CITIZEN_NUMBER_NOT_FOUND" } ] } } }, "/person-infos/{id}": { "delete": { "operationId": "delete-person-info", "tags": [ "person-infos" ], "summary": "delete-person-info", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "personInfoId" } } ], "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": "delete-person-info", "x-aura-domain": "integration", "x-aura-raw-url-path": "person-infos/{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" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is 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_47", "status": 400, "message": { "ar": "لم يتم العثور على معلمة معلومات الشخص.", "en": "Person Info Parameter not found.", "tr": "Kişi bilgisi bulunamadı" }, "message_available": true, "constant_name": "PERSON_INFO_NOT_FOUND" } ] } } }, "/pwf-transactions/check-approval": { "post": { "operationId": "check-transaction-approval", "tags": [ "pwf-transactions" ], "summary": "check-transaction-approval", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "customerId": { "type": "integer", "format": "int32", "x-aura-field-code": "pwfCustomerId" }, "transactionToken": { "type": "string", "x-aura-field-code": "transactionToken" } }, "required": [ "transactionToken" ] } } } }, "x-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": "check-transaction-approval", "x-aura-domain": "integration", "x-aura-raw-url-path": "pwf-transactions/check-approval", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "TransactionToken", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "CheckTransactionApprovalResult", "payload": "CheckTransactionApprovalResult", "collection": false, "members": [ { "name": "Status", "declared_type": "PwfTransactionStatus", "nullable": false, "collection": false }, { "name": "ClientIp", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TimeStamp", "declared_type": "long?", "nullable": true, "collection": false }, { "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 } } }, "/pwf-transactions/start-client": { "post": { "operationId": "start-client-transaction", "tags": [ "pwf-transactions" ], "summary": "start-client-transaction", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "applicationName": { "type": "string", "x-aura-field-code": "applicationName" }, "cancelOnBackPress": { "type": "boolean", "x-aura-field-code": "cancelOnBackPress" }, "cancelPendingTransactions": { "type": "boolean", "x-aura-field-code": "cancelPendingTransactions" }, "referenceToken": { "type": "string", "x-aura-field-code": "referenceToken" }, "timeoutDuration": { "type": "integer", "format": "int64", "x-aura-field-code": "timeoutDuration" }, "transactionApprovementTypeList": { "type": "array", "items": { "type": "integer", "format": "int32", "x-aura-field-code": "transactionApprovementTypeList" } }, "transactionContent": { "type": "string", "x-aura-field-code": "transactionContent" }, "transactionName": { "type": "string", "x-aura-field-code": "transactionName" }, "transactionOwner": { "type": "object", "properties": { "customerId": { "type": "integer", "format": "int32", "x-aura-field-code": "pwfCustomerId" }, "ownerKey": { "type": "string", "x-aura-field-code": "ownerKey" } }, "required": [ "customerId", "ownerKey" ], "x-aura-field-code": "transactionOwner" }, "transactionType": { "type": "integer", "format": "int32", "x-aura-field-code": "transactionType" } }, "required": [ "applicationName", "cancelOnBackPress", "cancelPendingTransactions", "referenceToken", "timeoutDuration", "transactionApprovementTypeList", "transactionContent", "transactionName", "transactionOwner", "transactionType" ] } } } }, "x-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": "start-client-transaction", "x-aura-domain": "integration", "x-aura-raw-url-path": "pwf-transactions/start-client", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "ApplicationName", "declared_type": null, "nullable": false, "collection": false }, { "name": "CancelPendingTransactions", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionContent", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionName", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionType", "declared_type": null, "nullable": false, "collection": false }, { "name": "TimeoutDuration", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionOwner", "declared_type": null, "nullable": false, "collection": false, "members": [ { "name": "OwnerKey", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false } ] }, { "name": "CancelOnBackPress", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReferenceToken", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "StartClientTransactionResponseDto", "payload": "StartClientTransactionResponseDto", "collection": false, "members": [ { "name": "PushToken", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransactionToken", "declared_type": "string", "nullable": false, "collection": false }, { "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 } } }, "/rm-segments": { "get": { "operationId": "get-rm-segment-list", "tags": [ "rm-segments" ], "summary": "get-rm-segment-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" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "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": { "additionalIndex": { "type": "integer", "format": "int32", "x-aura-field-code": "additionalIndex" }, "description": { "type": "string", "x-aura-field-code": "rmSegmentDescription" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "rmSegmentId" }, "isLatestVersion": { "type": "boolean", "x-aura-field-code": "isLatestVersion" }, "rmSegmentFields": { "type": "array", "items": { "type": "object", "properties": { "defaultValue": { "type": "string", "x-aura-field-code": "defaultFieldValue" }, "fieldCode": { "type": "string", "x-aura-field-code": "fieldcode" }, "fieldDescription": { "type": "string", "x-aura-field-code": "fieldDescription" }, "fieldGroupType": { "type": "integer", "format": "int32", "x-aura-field-code": "fieldGroupType" }, "fieldLength": { "type": "integer", "format": "int32", "x-aura-field-code": "fieldLength" }, "fieldOrder": { "type": "integer", "format": "int32", "x-aura-field-code": "fieldOrder" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "rmSegmentFieldParentId" }, "isMandatory": { "type": "boolean", "x-aura-field-code": "isMandatory" }, "rmSegmentId": { "type": "string", "format": "uuid", "x-aura-field-code": "rmSegmentId" }, "segmentDataType": { "type": "integer", "format": "int32", "x-aura-field-code": "segmentDataType" } }, "x-aura-field-code": "rmSegmentFields" } }, "segmentLength": { "type": "integer", "format": "int32", "x-aura-field-code": "segmentLength" }, "segmentName": { "type": "string", "x-aura-field-code": "segmentName" }, "segmentQueryOrder": { "type": "integer", "format": "int32", "x-aura-field-code": "segmentQueryOrder" }, "segmentType": { "type": "integer", "format": "int32", "x-aura-field-code": "segmentType" }, "segmentVersion": { "type": "string", "x-aura-field-code": "segmentVersion" } } }, "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-rm-segment-list", "x-aura-domain": "integration", "x-aura-raw-url-path": "rm-segments", "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": "RmSegmentDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "SegmentName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SegmentVersion", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SegmentType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "RmType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "SegmentLength", "declared_type": "int", "nullable": false, "collection": false }, { "name": "AdditionalIndex", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsLatestVersion", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "SegmentQueryOrder", "declared_type": "int", "nullable": false, "collection": false }, { "name": "RmSegmentFields", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." } } }, "/rm-segments/{id}/fields": { "get": { "operationId": "get-rm-segment-field-list", "tags": [ "rm-segments" ], "summary": "get-rm-segment-field-list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "rmSegmentFieldParentId" } }, { "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": 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. 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": { "defaultValue": { "type": "string", "x-aura-field-code": "defaultFieldValue" }, "fieldCode": { "type": "string", "x-aura-field-code": "fieldcode" }, "fieldDescription": { "type": "string", "x-aura-field-code": "fieldDescription" }, "fieldGroupType": { "type": "integer", "format": "int32", "x-aura-field-code": "fieldGroupType" }, "fieldLength": { "type": "integer", "format": "int32", "x-aura-field-code": "fieldLength" }, "fieldOrder": { "type": "integer", "format": "int32", "x-aura-field-code": "fieldOrder" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "rmSegmentFieldParentId" }, "isMandatory": { "type": "boolean", "x-aura-field-code": "isMandatory" }, "rmSegmentId": { "type": "string", "format": "uuid", "x-aura-field-code": "rmSegmentId" }, "segmentDataType": { "type": "integer", "format": "int32", "x-aura-field-code": "segmentDataType" } } }, "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-rm-segment-field-list", "x-aura-domain": "integration", "x-aura-raw-url-path": "rm-segments/{id}/fields", "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": "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": "RmSegmentFieldDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "RmSegmentId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "FieldCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FieldOrder", "declared_type": "int", "nullable": false, "collection": false }, { "name": "FieldLength", "declared_type": "int", "nullable": false, "collection": false }, { "name": "SegmentDataType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "IsMandatory", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "FieldGroupType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "DefaultValue", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FieldDescription", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/sms-notifications/report": { "post": { "operationId": "report-sms", "tags": [ "sms-notifications" ], "summary": "report-sms", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string", "x-aura-field-code": "smsGroupId" }, "messageIds": { "type": "array", "items": { "type": "string", "x-aura-field-code": "messageIds" } } }, "required": [ "groupId" ] } } } }, "x-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": { "responseCode": { "type": "string", "x-aura-field-code": "responseCode" }, "responseMessage": { "type": "string", "x-aura-field-code": "responseMessage" }, "resultMessageReports": { "type": "object", "properties": { "channel": { "type": "string", "x-aura-field-code": "channel" }, "deliveredDate": { "x-aura-type": "unresolved" }, "errorCode": { "type": "string", "x-aura-field-code": "errorCode" }, "gsmNumber": { "type": "string", "x-aura-field-code": "gsmNumber" }, "messageId": { "type": "string", "x-aura-field-code": "messageId" }, "responseCode": { "type": "string", "x-aura-field-code": "responseCode" }, "sMSValueToLength": { "x-aura-type": "unresolved" }, "sendDate": { "x-aura-type": "unresolved" }, "sendRetryCount": { "x-aura-type": "unresolved" }, "sendedSMSCount": { "x-aura-type": "unresolved" }, "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-type": "unresolved" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "responseCode": { "type": "string", "x-aura-field-code": "responseCode" }, "responseMessage": { "type": "string", "x-aura-field-code": "responseMessage" }, "resultMessageReports": { "type": "object", "properties": { "channel": { "type": "string", "x-aura-field-code": "channel" }, "deliveredDate": { "x-aura-type": "unresolved" }, "errorCode": { "type": "string", "x-aura-field-code": "errorCode" }, "gsmNumber": { "type": "string", "x-aura-field-code": "gsmNumber" }, "messageId": { "type": "string", "x-aura-field-code": "messageId" }, "responseCode": { "type": "string", "x-aura-field-code": "responseCode" }, "sMSValueToLength": { "x-aura-type": "unresolved" }, "sendDate": { "x-aura-type": "unresolved" }, "sendRetryCount": { "x-aura-type": "unresolved" }, "sendedSMSCount": { "x-aura-type": "unresolved" }, "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-type": "unresolved" } } }, "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" }, "responseMessage": { "type": "string", "x-aura-field-code": "responseMessage" }, "resultMessageReports": { "type": "object", "properties": { "channel": { "type": "string", "x-aura-field-code": "channel" }, "deliveredDate": { "x-aura-type": "unresolved" }, "errorCode": { "type": "string", "x-aura-field-code": "errorCode" }, "gsmNumber": { "type": "string", "x-aura-field-code": "gsmNumber" }, "messageId": { "type": "string", "x-aura-field-code": "messageId" }, "responseCode": { "type": "string", "x-aura-field-code": "responseCode" }, "sMSValueToLength": { "x-aura-type": "unresolved" }, "sendDate": { "x-aura-type": "unresolved" }, "sendRetryCount": { "x-aura-type": "unresolved" }, "sendedSMSCount": { "x-aura-type": "unresolved" }, "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-type": "unresolved" } } }, "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": "report-sms", "x-aura-domain": "integration", "x-aura-raw-url-path": "sms-notifications/report", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "unresolved", "note": "The repository declares `ReportSmsDto` 2 times and nothing in the route expression says which one. No structure is published rather than one picked at random.", "declared_type": "ReportSmsDto", "payload": "ReportSmsDto" } } }, "/sms-notifications/report-detail": { "post": { "operationId": "report-sms-detail", "tags": [ "sms-notifications" ], "summary": "report-sms-detail", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "endDate": { "type": "string", "format": "date", "x-aura-field-code": "endDate" }, "gsmNumber": { "type": "string", "x-aura-field-code": "gsmNumber" }, "originator": { "type": "string", "x-aura-field-code": "originator" }, "startDate": { "type": "string", "format": "date-time", "x-aura-field-code": "startDate" } }, "required": [ "endDate", "gsmNumber", "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": 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": { "description": { "type": "string", "x-aura-field-code": "description" }, "reportSMSDetailed": { "type": "object", "properties": { "ID": { "x-aura-type": "unresolved" }, "createDate": { "x-aura-type": "unresolved" }, "deliveredDate": { "x-aura-type": "unresolved" }, "messageText": { "type": "string", "x-aura-field-code": "messageText" }, "originator": { "type": "string", "x-aura-field-code": "originator" }, "phone": { "type": "string", "x-aura-field-code": "phone" }, "responseCode": { "type": "string", "x-aura-field-code": "responseCode" }, "sMSValueToLength": { "x-aura-type": "unresolved" }, "sendDate": { "x-aura-type": "unresolved" }, "sendRetryCount": { "x-aura-type": "unresolved" }, "sendedSMSCount": { "x-aura-type": "unresolved" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "status" } }, "x-aura-type": "unresolved" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "status" }, "url": { "type": "string", "x-aura-field-code": "url" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "description": { "type": "string", "x-aura-field-code": "description" }, "reportSMSDetailed": { "type": "object", "properties": { "ID": { "x-aura-type": "unresolved" }, "createDate": { "x-aura-type": "unresolved" }, "deliveredDate": { "x-aura-type": "unresolved" }, "messageText": { "type": "string", "x-aura-field-code": "messageText" }, "originator": { "type": "string", "x-aura-field-code": "originator" }, "phone": { "type": "string", "x-aura-field-code": "phone" }, "responseCode": { "type": "string", "x-aura-field-code": "responseCode" }, "sMSValueToLength": { "x-aura-type": "unresolved" }, "sendDate": { "x-aura-type": "unresolved" }, "sendRetryCount": { "x-aura-type": "unresolved" }, "sendedSMSCount": { "x-aura-type": "unresolved" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "status" } }, "x-aura-type": "unresolved" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "status" }, "url": { "type": "string", "x-aura-field-code": "url" } } }, "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": { "description": { "type": "string", "x-aura-field-code": "description" }, "reportSMSDetailed": { "type": "object", "properties": { "ID": { "x-aura-type": "unresolved" }, "createDate": { "x-aura-type": "unresolved" }, "deliveredDate": { "x-aura-type": "unresolved" }, "messageText": { "type": "string", "x-aura-field-code": "messageText" }, "originator": { "type": "string", "x-aura-field-code": "originator" }, "phone": { "type": "string", "x-aura-field-code": "phone" }, "responseCode": { "type": "string", "x-aura-field-code": "responseCode" }, "sMSValueToLength": { "x-aura-type": "unresolved" }, "sendDate": { "x-aura-type": "unresolved" }, "sendRetryCount": { "x-aura-type": "unresolved" }, "sendedSMSCount": { "x-aura-type": "unresolved" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "status" } }, "x-aura-type": "unresolved" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "status" }, "url": { "type": "string", "x-aura-field-code": "url" } } }, "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": "report-sms-detail", "x-aura-domain": "integration", "x-aura-raw-url-path": "sms-notifications/report-detail", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "x-aura-code-response": { "state": "unresolved", "note": "The repository declares `ReportSmsDetailDto` 2 times and nothing in the route expression says which one. No structure is published rather than one picked at random.", "declared_type": "ReportSmsDetailDto", "payload": "ReportSmsDetailDto" } } }, "/sms-notifications/send-broadcast": { "post": { "operationId": "send-broadcast-sms", "tags": [ "sms-notifications" ], "summary": "send-broadcast-sms", "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" } }, "messageType": { "type": "string", "x-aura-field-code": "messageType" } }, "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": [ "broadcastMessage" ] } } } }, "x-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" }, "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" }, "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" }, "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": "send-broadcast-sms", "x-aura-domain": "integration", "x-aura-raw-url-path": "sms-notifications/send-broadcast", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "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" } } }, "/sms-notifications/send-instant": { "post": { "operationId": "send-instant-sms", "tags": [ "sms-notifications" ], "summary": "send-instant-sms", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "blacklistFilter": { "type": "string", "x-aura-field-code": "blacklistFilter" }, "brandCode": { "type": "string", "x-aura-field-code": "brandCode" }, "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" } }, "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" } } } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 29, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's 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" }, "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" }, "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" }, "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": "send-instant-sms", "x-aura-domain": "integration", "x-aura-raw-url-path": "sms-notifications/send-instant", "x-aura-request-contract": { "state": "ambiguous-in-repo" }, "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" } } }, "/sms-notifications/send-otp": { "post": { "operationId": "send-otp", "tags": [ "sms-notifications" ], "summary": "send-otp", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "body": { "type": "string", "x-aura-field-code": "messageText" }, "gsmNumber": { "type": "string", "x-aura-field-code": "gsmNumber" }, "smsNotificationDetailId": { "type": "string", "format": "uuid", "x-aura-field-code": "smsNotificationDetailId" } }, "required": [ "body", "gsmNumber", "smsNotificationDetailId" ] } } } }, "x-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": "send-otp", "x-aura-domain": "integration", "x-aura-raw-url-path": "sms-notifications/send-otp", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "GsmNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "Body", "declared_type": null, "nullable": false, "collection": false }, { "name": "SmsNotificationDetailId", "declared_type": null, "nullable": false, "collection": false }, { "name": "ServiceDefinitionId", "declared_type": null, "nullable": true, "collection": false }, { "name": "Originator", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "unresolved", "note": "The repository declares `SendSmsResponse` 5 times and nothing in the route expression says which one. No structure is published rather than one picked at random.", "declared_type": "SendSmsResponse", "payload": "SendSmsResponse" } } }, "/verify-login-otp": { "post": { "operationId": "verify-login-otp", "tags": [ "verify-login-otp" ], "summary": "verify-login-otp", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "activationToken": { "type": "string", "x-aura-field-code": "activationToken" }, "applicationNames": { "type": "array", "items": { "type": "string", "x-aura-field-code": "applicationNames" } }, "customerId": { "type": "integer", "format": "int32", "x-aura-field-code": "pwfCustomerId" }, "loginOtp": { "type": "string", "x-aura-field-code": "loginOtp" } }, "required": [ "applicationNames", "customerId", "loginOtp" ] } } } }, "x-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": "verify-login-otp", "x-aura-domain": "integration", "x-aura-raw-url-path": "verify-login-otp", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "LoginOtp", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "ActivationToken", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "VerfiyLoginOtpResponseDto", "payload": "VerfiyLoginOtpResponseDto", "collection": false, "members": [ { "name": "Value", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "int?", "nullable": true, "collection": false }, { "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_69", "status": 400, "message": null, "message_available": false, "constant_name": "PWF_LOGIN_USER_NOT_MATCH" } ] } } }, "/verify/integration/add": { "post": { "operationId": "add-enqura-qualify", "tags": [ "verify" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "Add Enqura Qualify", "description": "Invokes the `add-enqura-qualify` service definition through `POST /verify/integration/add`.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "addressRegistration": { "type": "object", "properties": { "addressDetail": { "type": "string", "x-aura-field-code": "addressDetail" }, "addressType": { "type": "string", "x-aura-field-code": "enquraQualifyAddressType" }, "city": { "type": "string", "x-aura-field-code": "city", "x-aura-maskable": true }, "cityCode": { "type": "integer", "format": "int32", "x-aura-field-code": "cityCode" }, "country": { "type": "string", "x-aura-field-code": "enquraQualifyCountry" }, "countryCode": { "type": "integer", "format": "int32", "x-aura-field-code": "enquraQualifyCountryCode" }, "district": { "type": "string", "x-aura-field-code": "district", "x-aura-maskable": true }, "districtCode": { "type": "integer", "format": "int32", "x-aura-field-code": "enquraQualifyDistrictCode" }, "street": { "type": "string", "x-aura-field-code": "street", "x-aura-maskable": true }, "streetCode": { "type": "integer", "format": "int32", "x-aura-field-code": "streetCode" }, "town": { "type": "string", "x-aura-field-code": "town" }, "townCode": { "type": "integer", "format": "int32", "x-aura-field-code": "townCode" }, "villageCode": { "type": "integer", "format": "int32", "x-aura-field-code": "villageCode" } }, "x-aura-field-code": "addressRegistration" }, "callType": { "type": "string", "x-aura-field-code": "callType" }, "data": { "type": "string", "x-aura-field-code": "data" }, "email": { "type": "string", "x-aura-field-code": "email" }, "formUrl": { "type": "string", "x-aura-field-code": "formUrl" }, "iDRegistration": { "type": "object", "properties": { "birthDate": { "type": "string", "x-aura-field-code": "enquraQualifyBirthDate" }, "birthPlace": { "type": "string", "x-aura-field-code": "birthPlace" }, "documentNo": { "type": "string", "x-aura-field-code": "documentNo" }, "expireDate": { "type": "string", "x-aura-field-code": "enquraExpireDate" }, "fatherName": { "type": "string", "x-aura-field-code": "fatherName" }, "gender": { "type": "string", "x-aura-field-code": "enquraQualifyGender" }, "identityNo": { "type": "string", "x-aura-field-code": "identityNo" }, "identityType": { "type": "string", "x-aura-field-code": "enquraQualifyIdentityType" }, "issuedBy": { "type": "string", "x-aura-field-code": "issuedBy" }, "issuedDate": { "type": "string", "x-aura-field-code": "issuedDate" }, "motherName": { "type": "string", "x-aura-field-code": "motherName" }, "name": { "type": "string", "x-aura-field-code": "enquraQualifyName" }, "nationality": { "type": "string", "x-aura-field-code": "enquraQualifyNationality" }, "recordNo": { "type": "string", "x-aura-field-code": "enquraQualifyRecordNo" }, "registrationPlace": { "type": "string", "x-aura-field-code": "registrationPlace" }, "registrationPlaceFamilyRow": { "type": "string", "x-aura-field-code": "registrationPlaceFamilyRow" }, "registrationPlacePersonalRow": { "type": "string", "x-aura-field-code": "registrationPlacePersonalRow" }, "serialNo": { "type": "string", "x-aura-field-code": "serialNo" }, "surname": { "type": "string", "x-aura-field-code": "surname", "x-aura-maskable": true } }, "x-aura-field-code": "iDRegistration" }, "phone": { "type": "string", "x-aura-field-code": "phone" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "type": { "type": "string", "x-aura-field-code": "enquraQualifyType" } } } } } }, "x-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 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": "add-enqura-qualify", "x-aura-domain": "integration", "x-aura-raw-url-path": "verify/integration/add", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Type", "declared_type": null, "nullable": false, "collection": false }, { "name": "Reference", "declared_type": null, "nullable": false, "collection": false }, { "name": "CallType", "declared_type": null, "nullable": false, "collection": false }, { "name": "Phone", "declared_type": null, "nullable": false, "collection": false }, { "name": "Email", "declared_type": null, "nullable": false, "collection": false }, { "name": "FormUrl", "declared_type": null, "nullable": false, "collection": false }, { "name": "IDRegistration", "declared_type": null, "nullable": false, "collection": false }, { "name": "AddressRegistration", "declared_type": null, "nullable": false, "collection": false }, { "name": "Data", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ExternalServiceResultDto", "envelopes": [ "ExternalServiceResultDto" ], "payload": "AddEnquraQualifyDto", "collection": false, "members": [ { "name": "IsSuccessful", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "ReferenceId", "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 } } }, "/virtual-iban-results": { "get": { "operationId": "get-virtual-iban-result-list", "tags": [ "virtual-iban-results" ], "summary": "get-virtual-iban-result-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" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "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": { "externalServiceLogId": { "type": "string", "format": "uuid", "x-aura-field-code": "externalServiceLogId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "virtualIbanResultId" }, "isProccessed": { "type": "boolean", "x-aura-field-code": "isProccessed" }, "retryCount": { "type": "integer", "format": "int32", "x-aura-field-code": "retryCount" } } }, "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-virtual-iban-result-list", "x-aura-domain": "integration", "x-aura-raw-url-path": "virtual-iban-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-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": "VirtualIbanResultDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "IsProccessed", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "ExternalServiceLogId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "RetryCount", "declared_type": "int?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." } }, "post": { "operationId": "create-virtual-iban-result", "tags": [ "virtual-iban-results" ], "summary": "create-virtual-iban-result", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "externalServiceLogId": { "type": "string", "format": "uuid", "x-aura-field-code": "externalServiceLogId" }, "isProccessed": { "type": "boolean", "x-aura-field-code": "isProccessed" }, "retryCount": { "type": "integer", "format": "int32", "x-aura-field-code": "retryCount" } }, "required": [ "externalServiceLogId", "isProccessed", "retryCount" ] } } } }, "x-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 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": "create-virtual-iban-result", "x-aura-domain": "integration", "x-aura-raw-url-path": "virtual-iban-results", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "ExternalServiceLogId", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsProccessed", "declared_type": null, "nullable": false, "collection": false }, { "name": "RetryCount", "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 } } }, "/virtual-iban-results/{id}": { "delete": { "operationId": "delete-virtual-iban-result", "tags": [ "virtual-iban-results" ], "summary": "delete-virtual-iban-result", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "virtualIbanResultId" } } ], "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": "delete-virtual-iban-result", "x-aura-domain": "integration", "x-aura-raw-url-path": "virtual-iban-results/{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" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is 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_73", "status": 400, "message": { "ar": "لم يتم العثور على نتيجة تسجيل رقم حساب بنكي افتراضي (IBAN)", "en": "Virtual iban result registration not found.", "tr": "Sanal iban sonucu kaydı bulunamadı." }, "message_available": true, "constant_name": "VIRTUAL_IBAN_RESULT_NOT_FOUND" } ] } }, "get": { "operationId": "get-virtual-iban-result-by-id", "tags": [ "virtual-iban-results" ], "summary": "get-virtual-iban-result-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "externalServiceResultId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "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": { "externalServiceLogId": { "type": "string", "format": "uuid", "x-aura-field-code": "externalServiceLogId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "virtualIbanResultId" }, "isProccessed": { "type": "boolean", "x-aura-field-code": "isProccessed" }, "retryCount": { "type": "integer", "format": "int32", "x-aura-field-code": "retryCount" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what 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-virtual-iban-result-by-id", "x-aura-domain": "integration", "x-aura-raw-url-path": "virtual-iban-results/{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": "VirtualIbanResultDto", "payload": "VirtualIbanResultDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "IsProccessed", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "ExternalServiceLogId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "RetryCount", "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_INTGRTN_73", "status": 400, "message": { "ar": "لم يتم العثور على نتيجة تسجيل رقم حساب بنكي افتراضي (IBAN)", "en": "Virtual iban result registration not found.", "tr": "Sanal iban sonucu kaydı bulunamadı." }, "message_available": true, "constant_name": "VIRTUAL_IBAN_RESULT_NOT_FOUND" } ] } }, "put": { "operationId": "update-virtual-iban-result", "tags": [ "virtual-iban-results" ], "summary": "update-virtual-iban-result", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "virtualIbanResultId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "isProccessed": { "type": "boolean", "x-aura-field-code": "isProccessed" }, "retryCount": { "type": "integer", "format": "int32", "x-aura-field-code": "retryCount" } }, "required": [ "isProccessed", "retryCount" ] } } } }, "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": "update-virtual-iban-result", "x-aura-domain": "integration", "x-aura-raw-url-path": "virtual-iban-results/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsProccessed", "declared_type": null, "nullable": false, "collection": false }, { "name": "RetryCount", "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_INTGRTN_73", "status": 400, "message": { "ar": "لم يتم العثور على نتيجة تسجيل رقم حساب بنكي افتراضي (IBAN)", "en": "Virtual iban result registration not found.", "tr": "Sanal iban sonucu kaydı bulunamadı." }, "message_available": true, "constant_name": "VIRTUAL_IBAN_RESULT_NOT_FOUND" } ] } } }, "/zubizu/customer-info": { "post": { "operationId": "send-customer-info-zubizu", "tags": [ "zubizu" ], "summary": "send-customer-info-zubizu", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "countryCode": { "type": "string", "x-aura-field-code": "countryCode" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "phoneNumber": { "type": "string", "x-aura-field-code": "phoneNumber", "x-aura-maskable": true }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "status" } }, "required": [ "countryCode", "customerId", "phoneNumber", "status" ] } } } }, "x-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-customer-info-zubizu", "x-aura-domain": "integration", "x-aura-raw-url-path": "zubizu/customer-info", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "collection": false }, { "name": "CountryCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "PhoneNumber", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "SendCustomerInfoResponseDto", "payload": "SendCustomerInfoResponseDto", "collection": false, "members": [ { "name": "Success", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "Message", "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-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": 33 }, "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" } } } } } } }