account-product-rules
Operations addressed under /account-product-rules — 7 operations.
aurax-bff-dynamic-get-account-product-rule-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-account-product-rule-list; this entry declares none of its own.
Response body, read from the service source
The route declares its response as IEnumerable<AccountProductRuleDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Code | string | no |
FormulaDefinitionId | Guid | no |
BeginDate | DateOnly? | yes |
EndDate | DateOnly? | yes |
RuleType | int? | yes |
IsActive | bool? | yes |
AccountProductRuleMaps | List<AccountProductRuleMapDto> (collection) | no |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeaurax-bff-dynamic-get-account-product-rule-list › Responses
Success. Returns a page of records: the collection under data, with total carrying the unpaged count.
Response records carried by this page.
totalTotal matching records, ignoring paging.
aurax-bff-dynamic-create-account-product-rule-ui-bpm
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target create-account-product-rule-ui-bpm; this entry declares none of its own.
aurax-bff-dynamic-create-account-product-rule-ui-bpm › Request Body
codeformularuleTypebeginDateendDateaurax-bff-dynamic-create-account-product-rule-ui-bpm › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
aurax-bff-dynamic-get-account-product-rule-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-account-product-rule-by-id; this entry declares none of its own.
Response body, read from the service source
The route declares its response as AccountProductRuleDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Code | string | no |
FormulaDefinitionId | Guid | no |
BeginDate | DateOnly? | yes |
EndDate | DateOnly? | yes |
RuleType | int? | yes |
IsActive | bool? | yes |
AccountProductRuleMaps | List<AccountProductRuleMapDto> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCNT_109 | 400 | ACCOUNT_PRODUCT_RULE_NOT_FOUND | Account product rule not found. |
path Parameters
idaurax-bff-dynamic-get-account-product-rule-by-id › Responses
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.
beginDatecodeendDateformulaDefinitionIdidisActiveruleTypeaurax-bff-dynamic-edit-account-product-rule-ui-bpm
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target edit-account-product-rule-ui-bpm; this entry declares none of its own.
Declared as Route-bound but absent from the route template, so not sendable: formulaDefinitionId.
path Parameters
idaurax-bff-dynamic-edit-account-product-rule-ui-bpm › Request Body
codeformulaisActiveruleTypebeginDateendDateaurax-bff-dynamic-edit-account-product-rule-ui-bpm › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
aurax-bff-dynamic-delete-account-product-rule
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target delete-account-product-rule; this entry declares none of its own.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCNT_109 | 400 | ACCOUNT_PRODUCT_RULE_NOT_FOUND | Account product rule not found. |
ERR_ACCNT_113 | 400 | ACCOUNT_PRODUCT_RULE_CANNOT_BE_DELETED_IT_IS_USING_ON_ACCOUNT_PRODUCT | Account product rule cannot be deleted, it is being used on an account product. |
path Parameters
idaurax-bff-dynamic-delete-account-product-rule › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
aurax-bff-dynamic-get-account-product-rule-map-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-account-product-rule-map-list; this entry declares none of its own.
Response body, read from the service source
The route declares its response as IEnumerable<AccountProductRuleMapDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
AccountProductId | Guid? | yes |
AccountProductRuleId | Guid? | yes |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCNT_109 | 400 | ACCOUNT_PRODUCT_RULE_NOT_FOUND | Account product rule not found. |
path Parameters
idquery Parameters
orderByorderSortpageIndexpageSizeaurax-bff-dynamic-get-account-product-rule-map-list › Responses
Success. Returns a page of records: the collection under data, with total carrying the unpaged count.
Response records carried by this page.
totalTotal matching records, ignoring paging.
aurax-bff-dynamic-get-account-product-rule-map-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-account-product-rule-map-by-id; this entry declares none of its own.
Response body, read from the service source
The route declares its response as AccountProductRuleMapDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
AccountProductId | Guid? | yes |
AccountProductRuleId | Guid? | yes |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCNT_109 | 400 | ACCOUNT_PRODUCT_RULE_NOT_FOUND | Account product rule not found. |
ERR_ACCNT_110 | 400 | ACCOUNT_PRODUCT_RULE_MAP_NOT_FOUND | Account product rule map not found. |
path Parameters
idmapIdaurax-bff-dynamic-get-account-product-rule-map-by-id › Responses
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.
accountProductIdaccountProductRuleIdid